Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
WaitHandle Property
Collapse the table of content
Expand the table of content

CancellationToken.WaitHandle Property

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.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2015 Microsoft