CancellationTokenRegistration Structure

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Structure CancellationTokenRegistration _
    Implements IEquatable(Of CancellationTokenRegistration), IDisposable
public struct CancellationTokenRegistration : IEquatable<CancellationTokenRegistration>, 
    IDisposable

The CancellationTokenRegistration type exposes the following members.

Methods

  Name Description
Public method Dispose Releases all resources used by the current instance of the CancellationTokenRegistration class.
Public method Equals(CancellationTokenRegistration) Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration.
Public method Equals(Object) Determines whether the current CancellationTokenRegistration instance is equal to the specified CancellationTokenRegistration. (Overrides ValueType.Equals(Object).)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a CancellationTokenRegistration. (Overrides ValueType.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

  Name Description
Public operatorStatic member Equality Determines whether two CancellationTokenRegistration instances are equal.
Public operatorStatic member 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.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.