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

July 28, 2014

Creates and starts a Task<TResult>.

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

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

Type Parameters

TResult

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

Parameters

function
Type: System.Func<TResult>
A function delegate that returns the future result to be available through the Task<TResult>.
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.

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

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft