.NET Framework Class Library |
TaskFactory..::.StartNew Method (Action, CancellationToken, TaskCreationOptions, TaskScheduler) |
TaskFactory Class See Also Send Feedback |
Creates and starts a Task.
Namespace:
System.Threading.Tasks
Assembly:
System.Threading (in System.Threading.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function StartNew ( _ action As Action, _ cancellationToken As CancellationToken, _ creationOptions As TaskCreationOptions, _ scheduler As TaskScheduler _ ) As Task |
C# |
---|
public Task StartNew( Action action, CancellationToken cancellationToken, TaskCreationOptions creationOptions, TaskScheduler scheduler ) |
Parameters
- action
- Type: System..::.Action
The action delegate to execute asynchronously.
- 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
The started Task.Remarks
Calling StartNew is functionally equivalent to creating a Task 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.
Exceptions
Exception | Condition |
---|---|
System..::.ArgumentNullException | The exception that is thrown when the action argument is null. |
System..::.ArgumentNullException | The exception that is thrown when the scheduler argument is null. |
System..::.ArgumentOutOfRangeException | The exception that is thrown when the creationOptions argument specifies an invalid TaskCreationOptions value. |
System..::.ObjectDisposedException | The provided CancellationToken has already been disposed. |