• Article

CancellationToken.IsCancellationRequested Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets whether cancellation has been requested for this token.

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

Syntax

'Declaration
Public ReadOnly Property IsCancellationRequested As Boolean

public bool IsCancellationRequested { get; }

Property Value

Type: System.Boolean
true if cancellation has been requested for this token; otherwise false.

Remarks

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

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.