Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Task.WhenAll<TResult> Method (Task<TResult>[])

.NET Framework 4.6 and 4.5

Creates a task that will complete when all of the Task<TResult> objects in an array have completed.

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

public static Task<TResult[]> WhenAll<TResult>(
	params Task<TResult>[] tasks
)

Type Parameters

TResult

The type of the completed task.

Parameters

tasks
Type: System.Threading.Tasks.Task<TResult>[]

The tasks to wait on for completion.

Return Value

Type: System.Threading.Tasks.Task<TResult[]>
A task that represents the completion of all of the supplied tasks.

ExceptionCondition
ArgumentNullException

The tasks argument was null.

ArgumentException

The tasks array contained a null task.

If any of the supplied tasks completes in a faulted state, the returned task will also complete in a Faulted state, where its exceptions will contain the aggregation of the set of unwrapped exceptions from each of the supplied tasks.

If none of the supplied tasks faulted but at least one of them was canceled, the returned task will end in the Canceled state.

If none of the tasks faulted and none of the tasks were canceled, the resulting task will end in the RanToCompletion state. The Result of the returned task will be set to an array containing all of the results of the supplied tasks in the same order as they were provided (e.g. if the input tasks array contained t1, t2, t3, the output task's Result will return an TResult[] where arr[0] == t1.Result, arr[1] == t2.Result, and arr[2] == t3.Result).

If the supplied array/enumerable contains no tasks, the returned task will immediately transition to a RanToCompletion state before it's returned to the caller. The returned TResult[] will be an array of 0 elements.

The following example creates ten tasks, each of which instantiates a random number generator that creates 1,000 random numbers between 1 and 1,000 and computes their mean. In this case, the ten individual tasks are stored in a Task<Int64> array. The Delay(Int32) method is used to delay instantiation of the random number generators so that they are not created with identical seed values. The call to the WhenAll method then returns an Int64 array that contains the mean computed by each task. These are then used to calculate the overall mean.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var tasks = new Task<long>[10];
      for (int ctr = 1; ctr <= 10; ctr++) {
         int delayInterval = 18 * ctr;
         tasks[ctr - 1] = Task.Run(async () => { long total = 0;
                                                 await Task.Delay(delayInterval);
                                                 var rnd = new Random();
                                                 // Generate 1,000 random numbers. 
                                                 for (int n = 1; n <= 1000; n++)
                                                    total += rnd.Next(0, 1000);

                                                 return total; } );
      }
      var continuation = Task.WhenAll(tasks);
      long grandTotal = 0;
      foreach (var result in continuation.Result) {
         grandTotal += result;
         Console.WriteLine("Mean: {0:N2}, n = 1,000", result/1000.0);
      }

      Console.WriteLine("\nMean of Means: {0:N2}, n = 10,000",
                        grandTotal/10000);
   }
}
// The example displays output like the following: 
//       Mean: 506.38, n = 1,000 
//       Mean: 501.01, n = 1,000 
//       Mean: 505.36, n = 1,000 
//       Mean: 492.00, n = 1,000 
//       Mean: 508.36, n = 1,000 
//       Mean: 503.99, n = 1,000 
//       Mean: 504.95, n = 1,000 
//       Mean: 508.58, n = 1,000 
//       Mean: 490.23, n = 1,000 
//       Mean: 501.59, n = 1,000 
// 
//       Mean of Means: 502.00, n = 10,000

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft