CancellationToken.CanBeCanceled Property


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

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

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

public bool CanBeCanceled { get; }

Property Value

Type: System.Boolean

true 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 examing the value of the IsCancellationRequested property to determine whether it has been canceled.

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