Waits for any of the provided
Task objects to complete execution.
Namespace:
System.Threading.Tasks
Assembly:
System.Threading (in System.Threading.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Shared Function WaitAny ( _
tasks As Task(), _
millisecondsTimeout As Integer, _
cancellationToken As CancellationToken _
) As Integer |
| C# |
|---|
public static int WaitAny(
Task[] tasks,
int millisecondsTimeout,
CancellationToken cancellationToken
) |
Parameters
- tasks
- Type: array<
System.Threading.Tasks..::.Task
>[]()[]
An array of Task instances on which to wait.
- 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 a task to complete.
Return Value
The index of the completed task in the
tasks array argument, or -1 if the
timeout occurred.
Exceptions
| Exception | Condition |
|---|
| System..::.ArgumentNullException |
The tasks argument is null.
|
| System..::.ArgumentException |
The tasks argument contains a null element.
|
| 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
