WaitHandle Property
Collapse the table of content
Expand the table of content

CancellationToken.WaitHandle Property

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

Gets a WaitHandle that is signaled when the token is canceled.

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

public WaitHandle WaitHandle { get; }

Property Value

Type: System.Threading.WaitHandle
A WaitHandle that is signaled when the token is canceled.

ExceptionCondition
ObjectDisposedException

The associated CancellationTokenSource has been disposed.

Accessing this property causes a WaitHandle to be instantiated. It is preferable to only use this property when necessary, and to then dispose the associated CancellationTokenSource instance at the earliest opportunity (disposing the source will dispose of this allocated handle). The handle should not be closed or disposed directly.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2017 Microsoft