IsCancellationRequested Property

Task Parallel System.Threading

Gets whether cancellation has been requested for this token.

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 token.

Remarks

This property indicates whether cancellation has been requested for this token, either through the token initially being construted 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.

See Also