Factory Property

Task.Factory Property

 

Provides access to factory methods for creating and configuring Task and Task<TResult> instances.

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

public static TaskFactory Factory { get; }

Property Value

Type: System.Threading.Tasks.TaskFactory

A factory object that can create a variety of Task and Task<TResult> objects.

This property returns a default instance of the TaskFactory class that is identical to the one created by calling the parameterless TaskFactory.TaskFactory() constructor. It has the following property values:

Property

Value

TaskFactory.CancellationToken

CancellationToken.None

TaskFactory.ContinuationOptions

TaskContinuationOptions.None

TaskFactory.CreationOptions

TaskCreationOptions.None

TaskFactory.Scheduler

null, or TaskScheduler.Current

The most common use of this property is to create and start a new task in a single call to the TaskFactory.StartNew method.

System_CAPS_noteNote

Starting with the .NET Framework 4.5, the Task.Run method provides the easiest way to create a Task object with default configuration values.

The following example uses the static Factory property to make two calls to the TaskFactory.StartNew method. The first populates an array with the names of files in the user's MyDocuments directory, while the second populates an array with the names of subdirectories of the user's MyDocuments directory. It then calls the TaskFactory.ContinueWhenAll(Task[], Action<Task[]>) method, which displays information about the number of files and directories in the two arrays after the first two tasks have completed execution.

using System;
using System.IO;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      Task[] tasks = new Task[2];
      String[] files = null;
      String[] dirs = null;
      String docsDirectory = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);

      tasks[0] = Task.Factory.StartNew( () => files = Directory.GetFiles(docsDirectory));
      tasks[1] = Task.Factory.StartNew( () => dirs = Directory.GetDirectories(docsDirectory));

      Task.Factory.ContinueWhenAll(tasks, completedTasks => {
                                             Console.WriteLine("{0} contains: ", docsDirectory);
                                             Console.WriteLine("   {0} subdirectories", dirs.Length);
                                             Console.WriteLine("   {0} files", files.Length);
                                          } );
   }
}
// The example displays output like the following:
//       C:\Users\<username>\Documents contains:
//          24 subdirectories
//          16 files

Universal Windows Platform
Available since 4.5
.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