CountdownEvent.Wait Method (TimeSpan, CancellationToken)

.NET Framework (current version)
 
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.

Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.

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

public bool Wait(
	TimeSpan timeout,
	CancellationToken cancellationToken
)

Parameters

timeout
Type: System.TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken to observe.

Return Value

Type: System.Boolean

true if the CountdownEvent was set; otherwise, false.

Exception Condition
OperationCanceledException

cancellationToken has been canceled.

ObjectDisposedException

The current instance has already been disposed. -or- The CancellationTokenSource that created cancellationToken has already been disposed.

ArgumentOutOfRangeException

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

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