CancellationTokenSource.IsCancellationRequested Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets whether cancellation has been requested for this CancellationTokenSource.

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

Public ReadOnly Property IsCancellationRequested As Boolean

Property Value

Type: System.Boolean

true if cancellation has been requested for this CancellationTokenSource; otherwise, false.

This property indicates whether cancellation has been requested for this token source, such as due to a call to its Cancel method.

If this property returns true, it only guarantees that cancellation has been requested. It does not guarantee that every handler registered with the corresponding token 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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top