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

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 ( _
    function As Func(Of Object, TResult), _
    state As Object, _
    cancellationToken As CancellationToken _
) As Task(Of TResult)
public Task<TResult> StartNew(
    Func<Object, TResult> function,
    Object state,
    CancellationToken cancellationToken
)

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.

Return Value

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

Exceptions

Exception Condition
ObjectDisposedException

The CancellationTokenSource that created cancellationToken has already been disposed.

ArgumentNullException

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

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.