This topic has not yet been rated - Rate this topic

CancellationTokenRegistration Structure

.NET Framework 4.5

Represents a callback delegate that has been registered with a CancellationToken.

Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)

[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public value class CancellationTokenRegistration : IEquatable<CancellationTokenRegistration>, 
	IDisposable

The CancellationTokenRegistration type exposes the following members.

Methods

	Name	Description
	Dispose	Releases all resources used by the current instance of the CancellationTokenRegistration class.
	Equals(CancellationTokenRegistration)	Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration.
	Equals(Object)	Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration. (Overrides ValueType::Equals(Object).)
	GetHashCode	Serves as a hash function for a CancellationTokenRegistration. (Overrides ValueType::GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

	Name	Description
	Equality	Determines whether two CancellationTokenRegistration instances are equal.
	Inequality	Determines whether two CancellationTokenRegistration instances are not equal.

Top

Remarks

The callback is called when the token is canceled. To unregister a callback, dispose the corresponding Registration instance. For more information and code examples see Cancellation in Managed Threads.

Note
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization \| ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

All public and protected members of CancellationTokenRegistration are thread-safe and may be used concurrently from multiple threads, with the exception of Dispose, which must only be used when all other operations on the CancellationTokenRegistration have completed.

Reference

System.Threading Namespace

Other Resources

Cancellation in Managed Threads

Task Cancellation

How to: Register Callbacks for Cancellation Requests

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)