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

Waits for any of the provided Task objects to complete execution within a specified number of milliseconds or until a cancellation token is cancelled.

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

'Declaration
Public Shared Function WaitAny ( _
	tasks As Task(), _
	millisecondsTimeout As Integer, _
	cancellationToken As CancellationToken _
) As Integer

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 Nothing.

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.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft