CancellationToken.CanBeCanceled Property
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 : boolPublic ReadOnly Property CanBeCanceled As Booleantrue if this token is capable of being in the canceled state; otherwise, false.
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.
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
| .NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: