WaitAny Method (Task[], TimeSpan)

Task Parallel System.Threading

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(), _
	timeout As TimeSpan _
) As Integer
C#
public static int WaitAny(
	Task[] tasks,
	TimeSpan timeout
)

Parameters

tasks
Type: array< System.Threading.Tasks..::.Task >[]()[]
An array of Task instances on which to wait.
timeout
Type: System..::.TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Return Value

The index of the completed task in the tasks array argument, or -1 if the timeout occurred.

Exceptions

ExceptionCondition
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 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

See Also