ManualResetEventSlim.Wait Method (Int32, 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 current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval, while observing a CancellationToken.

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

Public Function Wait (
	millisecondsTimeout As Integer,
	cancellationToken As CancellationToken
) As Boolean

Parameters

millisecondsTimeout
Type: System.Int32

The number of milliseconds to wait, or Infinite(-1) to wait indefinitely.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken to observe.

Return Value

Type: System.Boolean

true if the ManualResetEventSlim was set; otherwise, false.

Exception Condition
OperationCanceledException

cancellationToken was canceled.

ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

InvalidOperationException

The maximum number of waiters has been exceeded.

ObjectDisposedException

The object has already been disposed or the CancellationTokenSource that created cancellationToken has been disposed.

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: