Article
11/17/2011

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

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Creates and starts a Task<TResult>.

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

Syntax

'Declaration
Public Function StartNew(Of TResult) ( _
    function As Func(Of Object, TResult), _
    state As Object, _
    cancellationToken As CancellationToken, _
    creationOptions As TaskCreationOptions, _
    scheduler As TaskScheduler _
) As Task(Of TResult)

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

Exceptions

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

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

Remarks

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.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Partager via