CancellationTokenRegistration Structure

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

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

public struct CancellationTokenRegistration : IDisposable, 
	IEquatable<CancellationTokenRegistration>

The CancellationTokenRegistration type exposes the following members.

  NameDescription
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 the Object 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.)
Top

  NameDescription
Public operatorStatic memberEqualityDetermines whether two CancellationTokenRegistration instances are equal.
Public operatorStatic memberInequalityDetermines 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 [eea11fe5-d8b0-4314-bb5d-8a58166fb1c3].

Windows Phone OS

Supported in: 8.1, 8.0

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