CancellationToken.IsCancellationRequested Property

Gets whether cancellation has been requested for this token.

Namespace:  System.Threading
Assemblies:   System.Threading.Tasks (in System.Threading.Tasks.dll)
  mscorlib (in mscorlib.dll)

public bool IsCancellationRequested { get; }

Property Value

Type: System.Boolean
true if cancellation has been requested for this token; otherwise false.

This property indicates whether cancellation has been requested for this token, either through the token initially being constructed in a canceled state, or through calling Cancel on the token's associated CancellationTokenSource.

If this property is true, it only guarantees that cancellation has been requested.

It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.

.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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft