CancellationToken Structure

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Propagates notification that operations should be canceled.

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

Syntax

Public Structure CancellationToken
public struct CancellationToken

The CancellationToken type exposes the following members.

Constructors

Name Description
CancellationToken Initializes the CancellationToken.

Top

Properties

Name Description
CanBeCanceled Gets whether this token is capable of being in the canceled state.
IsCancellationRequested Gets whether cancellation has been requested for this token.
None Returns an empty CancellationToken value.
WaitHandle Gets a WaitHandle that is signaled when the token is canceled.

Top

Methods

Name Description
Equals(CancellationToken) Determines whether the current CancellationToken instance is equal to the specified token.
Equals(Object) Determines whether the current CancellationToken instance is equal to the specified Object. (Overrides ValueType..::.Equals(Object).)
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.)
GetHashCode Serves as a hash function for a CancellationToken. (Overrides ValueType..::.GetHashCode()()().)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Register(Action) Registers a delegate that will be called when this CancellationToken is canceled.
Register(Action, Boolean) Registers a delegate that will be called when this CancellationToken is canceled.
Register(Action<(Of <(Object>)>), Object) Registers a delegate that will be called when this CancellationToken is canceled.
Register(Action<(Of <(Object>)>), Object, Boolean) Registers a delegate that will be called when this CancellationToken is canceled.
ThrowIfCancellationRequested Throws a OperationCanceledException if this token has had cancellation requested.
ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

Name Description
Equality Determines whether two CancellationToken instances are equal.
Inequality Determines whether two CancellationToken instances are not equal.

Top

Remarks

For more information and code examples see [eea11fe5-d8b0-4314-bb5d-8a58166fb1c3].

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

Thread Safety

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.

See Also

Reference

System.Threading Namespace