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

Creates and starts a task.

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

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

Parameters

function
Type: System.Func<Object, TResult>

A function delegate that returns the future result to be available through the task.

state
Type: System.Object

An object that contains data to be used by the function delegate.

cancellationToken
Type: System.Threading.CancellationToken

The cancellation token that will be assigned to the new task.

creationOptions
Type: System.Threading.Tasks.TaskCreationOptions

One of the enumeration values that controls the behavior of the created task.

scheduler
Type: System.Threading.Tasks.TaskScheduler

The task scheduler that is used to schedule the created task.

Return Value

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

ExceptionCondition
ObjectDisposedException

The cancellation token source that createdcancellationToken has already been disposed.

ArgumentNullException

The function argument is null.

-or-

The scheduler argument is null.

ArgumentOutOfRangeException

The creationOptions parameter specifies an invalid value.

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

However, unless creation and scheduling must be separated, StartNew is the recommended approach for both simplicity and performance.

.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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft