Export (0) Print
Expand All

TaskFactory.StartNew Method (Action(Of Object), Object, CancellationToken, TaskCreationOptions, TaskScheduler)

Creates and starts a Task.

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

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

Parameters

action
Type: System.Action(Of Object)

The action delegate to execute asynchronously.

state
Type: System.Object

An object containing data to be used by the action 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

scheduler
Type: System.Threading.Tasks.TaskScheduler

The TaskScheduler that is used to schedule the created Task.

Return Value

Type: System.Threading.Tasks.Task
The started Task.

ExceptionCondition
ObjectDisposedException

The provided CancellationToken has already been disposed.

ArgumentNullException

The exception that is thrown when the action 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

Calling StartNew is functionally equivalent to creating a Task using one of its constructors and then calling Start to schedule it for execution.

Starting with the .NET Framework 4.5, you can use the Run method with an Action object as a quick way to call StartNew with default parameters. For more information and code examples, see Task.Run vs Task.Factory.StartNew in the Parallel Programming with .NET blog.

.NET Framework

Supported in: 4.5.3, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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.

Show:
© 2014 Microsoft