CancellationToken Structure


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Propagates notification that operations should be canceled.

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

[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public value struct CancellationToken


Initializes the CancellationToken.


Gets whether this token is capable of being in the canceled state.


Gets whether cancellation has been requested for this token.


Returns an empty CancellationToken value.


Gets a WaitHandle that is signaled when the token is canceled.


Determines whether the current CancellationToken instance is equal to the specified token.


Determines whether the current CancellationToken instance is equal to the specified Object.(Overrides ValueType::Equals(Object^).)


Serves as a hash function for a CancellationToken.(Overrides ValueType::GetHashCode().)


Gets the Type of the current instance.(Inherited from Object.)


Registers a delegate that will be called when this CancellationToken is canceled.

System_CAPS_pubmethodRegister(Action^, Boolean)

Registers a delegate that will be called when this CancellationToken is canceled.

System_CAPS_pubmethodRegister(Action<Object^>^, Object^)

Registers a delegate that will be called when this CancellationToken is canceled.

System_CAPS_pubmethodRegister(Action<Object^>^, Object^, Boolean)

Registers a delegate that will be called when this CancellationToken is canceled.


Throws a OperationCanceledException if this token has had cancellation requested.


Returns the fully qualified type name of this instance.(Inherited from ValueType.)

System_CAPS_puboperatorSystem_CAPS_staticEquality(CancellationToken, CancellationToken)

Determines whether two CancellationToken instances are equal.

System_CAPS_puboperatorSystem_CAPS_staticInequality(CancellationToken, CancellationToken)

Determines whether two CancellationToken instances are not equal.

A CancellationToken enables cooperative cancellation between threads, thread pool work items, or Task objects. You create a cancellation token by instantiating a CancellationTokenSource object, which manages cancellation tokens retrieved from its CancellationTokenSource::Token property. You then pass the cancellation token to any number of threads, tasks, or operations that should receive notice of cancellation. The token cannot be used to initiate cancellation. When the owning object calls CancellationTokenSource::Cancel, the IsCancellationRequested property on every copy of the cancellation token is set to true. The objects that receive the notification can respond in whatever manner is appropriate.

For more information and code examples see Cancellation in Managed Threads.

The following example uses a random number generator to emulate a data collection application that reads 10 integral values from eleven different instruments. A value of zero indicates that the measurement has failed for one instrument, in which case the operation should be cancelled and no overall mean should be computed.

To handle the possible cancellation of the operation, the example instantiates a CancellationTokenSource object that generates a cancellation token which is passed to a TaskFactory object. The TaskFactory object in turn passes the cancellation token to each of the tasks responsible for collecting readings for a particular instrument. The TaskFactory::ContinueWhenAll<TAntecedentResult, TResult>(array<Task<TAntecedentResult>^>^, Func<array<Task<TAntecedentResult>^>^, TResult>^, CancellationToken) method is called to ensure that the mean is computed only after all readings have been gathered successfully. If a task has not because it has been cancelled, the call to the TaskFactory::ContinueWhenAll<TAntecedentResult, TResult> method throws an exception.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1

All public and protected members of CancellationToken are thread-safe and may be used concurrently from multiple threads.

Return to top