CancellationToken.CanBeCanceled Property

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Source:

CancellationToken.cs

Gets whether this token is capable of being in the canceled state.

public:
 property bool CanBeCanceled { bool get(); };

public bool CanBeCanceled { get; }

member this.CanBeCanceled : bool

Public ReadOnly Property CanBeCanceled As Boolean

Property Value

Boolean

true if this token is capable of being in the canceled state; otherwise, false.

Remarks

If CanBeCanceled returns false, it is guaranteed that the token will never transition into a canceled state, meaning that IsCancellationRequested will never return true. A cancellation token that cannot be canceled is returned by the static CancellationToken.None property.

You can optionally use this property to determine whether a cancellation token can be canceled before examining the value of the IsCancellationRequested property to determine whether it has been canceled.

See also

• Cancellation
• Task Cancellation