CancellationToken.WaitHandle Property

 
System_CAPS_noteNote

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

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.

Exception Condition
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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: