Task.WaitAll Method (array<Task[], Int32, CancellationToken)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Waits for all of the provided Task objects to complete execution.
Namespace: System.Threading.Tasks
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Shared Function WaitAll ( _
tasks As Task(), _
millisecondsTimeout As Integer, _
cancellationToken As CancellationToken _
) As Boolean
public static bool WaitAll(
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 the tasks to complete.
Return Value
Type: System.Boolean
true if all of the Task instances completed execution within the allotted time; otherwise, false.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | One or more of the Task objects in tasks has been disposed. |
| ArgumentNullException | The tasks argument is null. |
| AggregateException | At least one of the Task instances was canceled -or- an exception was thrown during the execution of at least one of the Task instances. If a task was canceled, the AggregateException contains an OperationCanceledException in its InnerExceptions collection. |
| 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. |
Remarks
The cancellationToken argument is used to cancel the wait operation. If it is canceled, the Wait returns false (False in Visual Basic). Cancellation of the tasks is a distinct operation, and is signaled by the AggregateException as noted above.
Version Information
Silverlight
Supported in: 5
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.