Export (0) Print
Expand All

CancellationToken Structure

Propagates notification that operations should be canceled.

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

[ComVisibleAttribute(false)]
[DebuggerDisplayAttribute(L"IsCancellationRequested = {IsCancellationRequested}")]
[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public value class CancellationToken

The CancellationToken type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryCancellationTokenInitializes the CancellationToken.
Top

  NameDescription
Public propertySupported by Portable Class LibraryCanBeCanceledGets whether this token is capable of being in the canceled state.
Public propertySupported by Portable Class LibraryIsCancellationRequestedGets whether cancellation has been requested for this token.
Public propertyStatic memberSupported by Portable Class LibraryNoneReturns an empty CancellationToken value.
Public propertySupported by Portable Class LibraryWaitHandleGets a WaitHandle that is signaled when the token is canceled.
Top

  NameDescription
Public methodSupported by Portable Class LibraryEquals(CancellationToken)Determines whether the current CancellationToken instance is equal to the specified token.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the current CancellationToken instance is equal to the specified Object. (Overrides ValueType::Equals(Object).)
Public methodSupported by Portable Class LibraryGetHashCodeServes as a hash function for a CancellationToken. (Overrides ValueType::GetHashCode().)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryRegister(Action)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibraryRegister(Action, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibraryRegister(Action<Object>, Object)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibraryRegister(Action<Object>, Object, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibraryThrowIfCancellationRequestedThrows a OperationCanceledException if this token has had cancellation requested.
Public methodSupported by Portable Class LibraryToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Top

  NameDescription
Public operatorStatic memberSupported by Portable Class LibraryEqualityDetermines whether two CancellationToken instances are equal.
Public operatorStatic memberSupported by Portable Class LibraryInequalityDetermines whether two CancellationToken instances are not equal.
Top

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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

Show:
© 2015 Microsoft