Task.Run(Of TResult) Method (Func(Of 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)

'Declaration
Public Shared Function Run(Of TResult) ( _
	function As Func(Of TResult), _
	cancellationToken As CancellationToken _
) As Task(Of TResult)

Type Parameters

TResult

The result type of the task.

Parameters

function
Type: System.Func(Of 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(Of TResult)
A Task(TResult) that represents the work queued to execute in the ThreadPool.

ExceptionCondition
ArgumentNullException

The function parameter was Nothing.

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.5.2, 4.5.1, 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft