Task.Wait Method (Int32, CancellationToken)

Waits for the Task to complete execution.

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

Syntax

'Declaration
Public Function Wait ( _
    millisecondsTimeout As Integer, _
    cancellationToken As CancellationToken _
) As Boolean
public bool Wait(
    int millisecondsTimeout,
    CancellationToken cancellationToken
)

Parameters

  • millisecondsTimeout
    Type: System.Int32
    The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

Return Value

Type: System.Boolean
true if the Task completed execution within the allotted time; otherwise, false.

Exceptions

Exception Condition
OperationCanceledException

The cancellationToken was canceled.

ObjectDisposedException

The Task has been disposed.

ArgumentOutOfRangeException

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

AggregateException

The Task was canceled -or- an exception was thrown during the execution of the Task. If the task was canceled, the AggregateException contains an OperationCanceledException in its InnerExceptions collection.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.