Wait Method (Int32, CancellationToken)

Task Parallel System.Threading

previous page next page

Waits for the Task to complete execution.

Namespace:  System.Threading.Tasks
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
A CancellationToken()()() to observe while waiting for the task to complete.

Return Value

true if the Task completed execution within the allotted time; otherwise, false.

Exceptions

ExceptionCondition
System..::.AggregateException The Task was canceled -or- an exception was thrown during the execution of the Task.
System..::.ObjectDisposedException The Task has been disposed.
System..::.ArgumentOutOfRangeException millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
System..::.OperationCanceledException The cancellationToken was canceled.

See Also

previous page start next page