IsCancellationRequested Property

Task Parallel System.Threading

Gets whether cancellation has been requested for this CancellationTokenSource.

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

Syntax

Visual Basic (Declaration)
Public ReadOnly Property IsCancellationRequested As Boolean
C#
public bool IsCancellationRequested { get; }

Field Value

Whether cancellation has been requested for this CancellationTokenSource.

Remarks

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.

See Also