Export (0) Print
Expand All

Task.WaitAny Method (Task[], Int32, CancellationToken)

Waits for any of the provided cancellable Task objects to complete execution within a specified number of milliseconds.

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

public static int WaitAny(
	Task[] tasks,
	int millisecondsTimeout,
	CancellationToken cancellationToken
)

Parameters

tasks
Type: 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

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

ExceptionCondition
ObjectDisposedException

The Task has been disposed.

ArgumentNullException

The tasks argument is null.

ArgumentOutOfRangeException

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

ArgumentException

The tasks argument contains a null element.

OperationCanceledException

The cancellationToken was canceled.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft