CancellationToken Structure

Propagates notification that operations should be canceled.

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

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public struct CancellationToken

The CancellationToken type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsCancellationTokenInitializes the CancellationToken.
Top

  NameDescription
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsCanBeCanceledGets whether this token is capable of being in the canceled state.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsIsCancellationRequestedGets whether cancellation has been requested for this token.
Public propertyStatic memberSupported by Portable Class LibrarySupported in .NET for Windows Store appsNoneReturns an empty CancellationToken value.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsWaitHandleGets a WaitHandle that is signaled when the token is canceled.
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(CancellationToken)Determines whether the current CancellationToken instance is equal to the specified token.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the current CancellationToken instance is equal to the specified Object. (Overrides ValueType.Equals(Object).)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as a hash function for a CancellationToken. (Overrides ValueType.GetHashCode().)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsRegister(Action)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsRegister(Action, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsRegister(Action<Object>, Object)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsRegister(Action<Object>, Object, Boolean)Registers a delegate that will be called when this CancellationToken is canceled.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsThrowIfCancellationRequestedThrows a OperationCanceledException if this token has had cancellation requested.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Top

  NameDescription
Public operatorStatic memberSupported by Portable Class LibrarySupported in .NET for Windows Store appsEqualityDetermines whether two CancellationToken instances are equal.
Public operatorStatic memberSupported by Portable Class LibrarySupported in .NET for Windows Store appsInequalityDetermines 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.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft