IsCancellationRequested Property
Collapse the table of content
Expand the table of content

CancellationToken.IsCancellationRequested Property

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Gets whether cancellation has been requested for this token.

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

'Declaration
Public ReadOnly Property IsCancellationRequested As Boolean

Property Value

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

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.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft