Windows Dev Center

TaskFactory.StartNew<TResult> Method (Func<Object, TResult>, Object, CancellationToken, TaskCreationOptions, TaskScheduler)

Creates and starts a Task<TResult>.

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

public Task<TResult> StartNew<TResult>(
	Func<Object, TResult> function,
	Object state,
	CancellationToken cancellationToken,
	TaskCreationOptions creationOptions,
	TaskScheduler scheduler
)

Type Parameters

TResult

The type of the result available through the Task<TResult>.

Parameters

function
Type: System.Func<Object, TResult>

A function delegate that returns the future result to be available through the Task<TResult>.

state
Type: System.Object

An object containing data to be used by the function delegate.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken that will be assigned to the new task.

creationOptions
Type: System.Threading.Tasks.TaskCreationOptions

A TaskCreationOptions value that controls the behavior of the created Task<TResult>.

scheduler
Type: System.Threading.Tasks.TaskScheduler

The TaskScheduler that is used to schedule the created Task<TResult>.

Return Value

Type: System.Threading.Tasks.Task<TResult>
The started Task<TResult>.

ExceptionCondition
ObjectDisposedException

The provided CancellationToken has already been disposed.

ArgumentNullException

The exception that is thrown when the function argument is null.

-or-

The exception that is thrown when the scheduler argument is null.

ArgumentOutOfRangeException

The exception that is thrown when the creationOptions argument specifies an invalid TaskCreationOptions value. The exception that is thrown when the creationOptions argument specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync

Calling StartNew is functionally equivalent to creating a Task<TResult> using one of its constructors and then calling Start to schedule it for execution.

Starting with the .NET Framework 4.5, you can use the Run method with an Action object as a quick way to call StartNew with default parameters. For more information and code examples, see the entry Task.Run vs. Task.Factory.StartNew in the Parallel Programming with .NET blog.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft