This documentation is archived and is not being maintained.

CancellationTokenRegistration Structure

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)>]
type CancellationTokenRegistration =  
        interface IEquatable<CancellationTokenRegistration>
        interface IDisposable

The CancellationTokenRegistration type exposes the following members.

Public methodDisposeReleases all resources used by the current instance of the CancellationTokenRegistration class.
Public methodEquals(CancellationTokenRegistration)Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration.
Public methodEquals(Object)Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration. (Overrides ValueType.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a CancellationTokenRegistration. (Overrides ValueType.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public operatorStatic memberEqualityDetermines whether two CancellationTokenRegistration instances are equal.
Public operatorStatic memberInequalityDetermines whether two CancellationTokenRegistration instances are not equal.

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.


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

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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.