Wait Method (TimeSpan, CancellationToken)

Task Parallel System.Threading

Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval, while observing a CancellationToken.

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

Syntax

Visual Basic (Declaration)
Public Function Wait ( _
	timeout As TimeSpan, _
	cancellationToken As CancellationToken _
) As Boolean
C#
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

true if the ManualResetEventSlim was set; otherwise, false.

Exceptions

ExceptionCondition
System..::.ArgumentOutOfRangeExceptiontimeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.
OperationCanceledExceptioncancellationToken was canceled.
System..::.InvalidOperationException The maximum number of waiters has been exceeded.

See Also