TaskFactory::StartNew<TResult> Method (Func<TResult>^, CancellationToken)
Creates and starts a Task<TResult>.
Assembly: mscorlib (in mscorlib.dll)
public: generic<typename TResult> Task<TResult>^ StartNew( Func<TResult>^ function, CancellationToken cancellationToken )
Parameters
- function
-
Type:
System::Func<TResult>^
A function delegate that returns the future result to be available through the Task<TResult>.
- cancellationToken
-
Type:
System.Threading::CancellationToken
The CancellationToken that will be assigned to the new Task
Type Parameters
- TResult
The type of the result available through the Task<TResult>.
| Exception | Condition |
|---|---|
| ObjectDisposedException | The provided CancellationToken has already been disposed. |
| ArgumentNullException | The exception that is thrown when the function argument is null. |
Calling StartNew<TResult> is functionally equivalent to creating a Task<TResult> 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 Task::Run<TResult>(Func<TResult>^, CancellationToken) method as a quick way to call StartNew<TResult>(Func<TResult>^, CancellationToken) with default parameters. Note, however, that there is a difference in behavior between the two methods regarding : Task::Run<TResult>(Func<TResult>^, CancellationToken) by default does not allow child tasks started with the TaskCreationOptions::AttachedToParent option to attach to the current Task<TResult> instance, whereas StartNew<TResult>(Func<TResult>^, CancellationToken) does. For more information and code examples, see the entry Task.Run vs. Task.Factory.StartNew in the Parallel Programming with .NET blog.
The following example uses two tasks to compute the Fibonacci sequence ending in F100 = F100-1 + F100-2 with seed values F1= 1, F2 = 1 and F1 = 0, F2= 1. Approximately half of the time, a cancellation token is set as the operations execute. The output from the example shows the result if the two tasks complete successfully and if the token is cancelled.
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1