CancellationToken Structure

July 28, 2014

Propagates notification that operations should be canceled.

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

public struct CancellationToken

The CancellationToken type exposes the following members.

  NameDescription
Public methodCancellationTokenInitializes the CancellationToken.
Top

  NameDescription
Public propertyCanBeCanceledGets whether this token is capable of being in the canceled state.
Public propertyIsCancellationRequestedGets whether cancellation has been requested for this token.
Public propertyStatic memberNoneReturns an empty CancellationToken value.
Public propertyWaitHandleGets a WaitHandle that is signaled when the token is canceled.
Top

  NameDescription
Public methodEquals(CancellationToken)Determines whether the current CancellationToken instance is equal to the specified token.
Public methodEquals(Object)Determines whether the current CancellationToken instance is equal to the specified Object. (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 CancellationToken. (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 methodRegister(Action)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodRegister(Action, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodRegister(Action<Object>, Object)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodRegister(Action<Object>, Object, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodThrowIfCancellationRequestedThrows a OperationCanceledException if this token has had cancellation requested.
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Top

  NameDescription
Public operatorStatic memberEqualityDetermines whether two CancellationToken instances are equal.
Public operatorStatic memberInequalityDetermines whether two CancellationToken instances are not equal.
Top

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 CancellationToken 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 CancellationToken have completed.

Show:
© 2014 Microsoft