Task.Run Method (Func<Task>, CancellationToken)

.NET Framework 4.6 and 4.5

Queues the specified work to run on the ThreadPool and returns a proxy for the task returned by function.

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

public static Task Run(
	Func<Task> function,
	CancellationToken cancellationToken
)

Parameters

function
Type: System.Func<Task>

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
A task that represents a proxy for the task returned by function.

ExceptionCondition
ArgumentNullException

The function parameter was null.

TaskCanceledException

The task has been canceled.

ObjectDisposedException

The CancellationTokenSource associated with cancellationToken was disposed.

NoteNote

The Run(Func<Task>, CancellationToken) method is used by language compilers to support the async and await keywords. It is not intended to be called directly from user code.

.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