Wait Method (Int32, CancellationToken)

Task Parallel System.Threading

previous page next page

Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer 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 ( _
	millisecondsTimeout As Integer, _
	cancellationToken As CancellationToken _
) As Boolean
C#
public bool Wait(
	int millisecondsTimeout,
	CancellationToken cancellationToken
)

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

true if the CountdownEvent was set; otherwise, false.

Exceptions

ExceptionCondition
System..::.ArgumentOutOfRangeExceptionmillisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
System..::.ObjectDisposedExceptionThe current instance has already been disposed.
System..::.OperationCanceledExceptioncancellationToken has been canceled.

See Also

previous page start next page