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

 

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
)

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>.

Type Parameters

TResult

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

Exception Condition
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.

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