WaitAny Method (Task[], Int32, CancellationToken)
Collapse the table of content
Expand the table of content

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
Assembly:  mscorlib (in mscorlib.dll)

static member WaitAny : 
        tasks:Task[] *
        millisecondsTimeout:int *
        cancellationToken:CancellationToken -> int

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.

Exception Condition
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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft