Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

CancellationTokenRegistration Structure

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

Namespace:  System.Threading
Assemblies:   mscorlib (in mscorlib.dll)
  System.Threading.Tasks (in System.Threading.Tasks.dll)

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

The CancellationTokenRegistration type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryDisposeReleases all resources used by the current instance of the CancellationTokenRegistration class.
Public methodSupported by Portable Class LibraryEquals(CancellationTokenRegistration)Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration. (Overrides ValueType.Equals(Object).)
Public methodSupported by Portable Class LibraryGetHashCodeServes as a hash function for a CancellationTokenRegistration. (Overrides ValueType.GetHashCode().)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Top

  NameDescription
Public operatorStatic memberSupported by Portable Class LibraryEqualityDetermines whether two CancellationTokenRegistration instances are equal.
Public operatorStatic memberSupported by Portable Class LibraryInequalityDetermines whether two CancellationTokenRegistration instances are not equal.
Top

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.

NoteNote

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.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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.

Show:
© 2015 Microsoft