Task.Run(TResult) Method (Func(TResult), CancellationToken)

.NET Framework 4.5

Queues the specified work to run on the thread pool and returns a Task(TResult) handle for that work.

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

static member Run : 
        function:Func<'TResult> * 
        cancellationToken:CancellationToken -> Task<'TResult> 

Type Parameters

TResult

The result type of the task.

Parameters

function
Type: System.Func(TResult)

The work to execute asynchronously

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that should be used to cancel the work

Return Value

Type: System.Threading.Tasks.Task(TResult)
A Task(TResult) that represents the work queued to execute in the ThreadPool.

ExceptionCondition
ArgumentNullException

The function parameter was a null reference (Nothing in Visual Basic).

TaskCanceledException

The task has been canceled.

ObjectDisposedException

The CancellationTokenSource associated with cancellationToken was disposed.

The Run method is a simpler alternative to the StartNew method. It creates a task with the following default values:

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft