Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

CancellationToken Structure

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Propagates notification that operations should be canceled.

Namespace:  System.Threading
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 

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

The CancellationToken type exposes the following members.

  Name Description
Public method Supported by Portable Class Library CancellationToken Initializes the CancellationToken.
Top
  Name Description
Public property Supported by Portable Class Library CanBeCanceled Gets whether this token is capable of being in the canceled state.
Public property Supported by Portable Class Library IsCancellationRequested Gets whether cancellation has been requested for this token.
Public property Static member Supported by Portable Class Library None Returns an empty CancellationToken value.
Public property Supported by Portable Class Library WaitHandle Gets a WaitHandle that is signaled when the token is canceled.
Top
  Name Description
Public method Supported by Portable Class Library Equals(CancellationToken) Determines whether the current CancellationToken instance is equal to the specified token.
Public method Supported by Portable Class Library Equals(Object) Determines whether the current CancellationToken instance is equal to the specified Object. (Overrides ValueType.Equals(Object).)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a CancellationToken. (Overrides ValueType.GetHashCode().)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by Portable Class Library Register(Action) Registers a delegate that will be called when this CancellationToken is canceled.
Public method Supported by Portable Class Library Register(Action, Boolean) Registers a delegate that will be called when this CancellationToken is canceled.
Public method Supported by Portable Class Library Register(Action<Object>, Object) Registers a delegate that will be called when this CancellationToken is canceled.
Public method Supported by Portable Class Library Register(Action<Object>, Object, Boolean) Registers a delegate that will be called when this CancellationToken is canceled.
Public method Supported by Portable Class Library ThrowIfCancellationRequested Throws a OperationCanceledException if this token has had cancellation requested.
Public method Supported by Portable Class Library ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)
Top
  Name Description
Public operator Static member Supported by Portable Class Library Equality Determines whether two CancellationToken instances are equal.
Public operator Static member Supported by Portable Class Library Inequality Determines whether two CancellationToken instances are not equal.
Top

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

Note Note

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

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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, with the exception of Dispose, which must only be used when all other operations on the CancellationToken have completed.

Did you find this helpful?
(1500 characters remaining)