CancellationToken.WaitHandle Property
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Gets a WaitHandle that is signaled when the token is canceled.
Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public ReadOnly Property WaitHandle As WaitHandle
public WaitHandle WaitHandle { get; }
Property Value
Type: System.Threading.WaitHandle
A WaitHandle that is signaled when the token is canceled.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The associated CancellationTokenSource has been disposed. |
Remarks
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.
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.