TaskFactory.FromAsync Method

Definition

Namespace:

System.Threading.Tasks

Assembly:

System.Runtime.dll

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

Overloads

FromAsync(IAsyncResult, Action<IAsyncResult>)	Creates a Task that executes an end method action when a specified IAsyncResult completes.
FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions)	Creates a Task that executes an end method action when a specified IAsyncResult completes.
FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions, TaskScheduler)	Creates a Task that executes an end method action when a specified IAsyncResult completes.
FromAsync<TArg1,TArg2,TArg3,TResult>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2,TArg3,TResult>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2,TResult>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2,TResult>(Func<TArg1,TArg2,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object, TaskCreationOptions)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, Object)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, Object, TaskCreationOptions)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TResult>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1,TResult>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object, TaskCreationOptions)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, Object, TaskCreationOptions)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, Object)	Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions, TaskScheduler)	Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions)	Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
FromAsync<TResult>(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>)	Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
FromAsync<TResult>(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object, TaskCreationOptions)	Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

FromAsync(IAsyncResult, Action<IAsyncResult>)

Source:

TaskFactory.cs

Creates a Task that executes an end method action when a specified IAsyncResult completes.

public:
 System::Threading::Tasks::Task ^ FromAsync(IAsyncResult ^ asyncResult, Action<IAsyncResult ^> ^ endMethod);

public System.Threading.Tasks.Task FromAsync (IAsyncResult asyncResult, Action<IAsyncResult> endMethod);

member this.FromAsync : IAsyncResult * Action<IAsyncResult> -> System.Threading.Tasks.Task

Public Function FromAsync (asyncResult As IAsyncResult, endMethod As Action(Of IAsyncResult)) As Task

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Action<IAsyncResult>

The action delegate that processes the completed asyncResult.

Returns

Task

A Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
 System::Threading::Tasks::Task ^ FromAsync(Func<AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, System::Object ^ state);

public System.Threading.Tasks.Task FromAsync (Func<AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, object? state);

member this.FromAsync : Func<AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * obj -> System.Threading.Tasks.Task

Public Function FromAsync (beginMethod As Func(Of AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), state As Object) As Task

Parameters

beginMethod

Func<AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task that executes an end method action when a specified IAsyncResult completes.

public:
 System::Threading::Tasks::Task ^ FromAsync(IAsyncResult ^ asyncResult, Action<IAsyncResult ^> ^ endMethod, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task FromAsync (IAsyncResult asyncResult, Action<IAsyncResult> endMethod, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : IAsyncResult * Action<IAsyncResult> * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task

Public Function FromAsync (asyncResult As IAsyncResult, endMethod As Action(Of IAsyncResult), creationOptions As TaskCreationOptions) As Task

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Action<IAsyncResult>

The action delegate that processes the completed asyncResult.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

Returns

Task

A Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

paramref name="creationOptions" /> specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
 System::Threading::Tasks::Task ^ FromAsync(Func<AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task FromAsync (Func<AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task

Public Function FromAsync (beginMethod As Func(Of AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), state As Object, creationOptions As TaskCreationOptions) As Task

Parameters

beginMethod

Func<AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod. The TaskCreationOptions values PreferFairness, LongRunning and AttachedToParent are all mutually exclusive. In the FromAsync methods, either LongRunning or AttachedToParent by themselves will cause an ArgumentOutOfRangeException to be thrown.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions, TaskScheduler)

Source:

TaskFactory.cs

Creates a Task that executes an end method action when a specified IAsyncResult completes.

public:
 System::Threading::Tasks::Task ^ FromAsync(IAsyncResult ^ asyncResult, Action<IAsyncResult ^> ^ endMethod, System::Threading::Tasks::TaskCreationOptions creationOptions, System::Threading::Tasks::TaskScheduler ^ scheduler);

public System.Threading.Tasks.Task FromAsync (IAsyncResult asyncResult, Action<IAsyncResult> endMethod, System.Threading.Tasks.TaskCreationOptions creationOptions, System.Threading.Tasks.TaskScheduler scheduler);

member this.FromAsync : IAsyncResult * Action<IAsyncResult> * System.Threading.Tasks.TaskCreationOptions * System.Threading.Tasks.TaskScheduler -> System.Threading.Tasks.Task

Public Function FromAsync (asyncResult As IAsyncResult, endMethod As Action(Of IAsyncResult), creationOptions As TaskCreationOptions, scheduler As TaskScheduler) As Task

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Action<IAsyncResult>

The action delegate that processes the completed asyncResult.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

scheduler

TaskScheduler

The TaskScheduler that is used to schedule the task that executes the end method.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

-or-

scheduler is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TArg3,TResult>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TArg3, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, TArg2, TArg3, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TArg2,TArg3,TResult> (Func<TArg1,TArg2,TArg3,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, 'TArg2, 'TArg3, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * 'TArg2 * 'TArg3 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TArg2, TArg3, TResult) (beginMethod As Func(Of TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, arg2 As TArg2, arg3 As TArg3, state As Object, creationOptions As TaskCreationOptions) As Task(Of TResult)

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the third argument passed to beginMethod delegate.

TArg3

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

arg3

TArg3

The third argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TArg3,TResult>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, TArg3, Object)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TArg3, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, TArg2, TArg3, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, System::Object ^ state);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TArg2,TArg3,TResult> (Func<TArg1,TArg2,TArg3,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, object? state);

member this.FromAsync : Func<'TArg1, 'TArg2, 'TArg3, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * 'TArg2 * 'TArg3 * obj -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TArg2, TArg3, TResult) (beginMethod As Func(Of TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, arg2 As TArg2, arg3 As TArg3, state As Object) As Task(Of TResult)

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the third argument passed to beginMethod delegate.

TArg3

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

arg3

TArg3

The third argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback, Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TArg3>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, TArg2, TArg3, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task FromAsync<TArg1,TArg2,TArg3> (Func<TArg1,TArg2,TArg3,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, 'TArg2, 'TArg3, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * 'TArg2 * 'TArg3 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1, TArg2, TArg3) (beginMethod As Func(Of TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, arg2 As TArg2, arg3 As TArg3, state As Object, creationOptions As TaskCreationOptions) As Task

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the third argument passed to beginMethod delegate.

TArg3

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

arg3

TArg3

The third argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TArg3>(Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TArg3>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, TArg2, TArg3, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, System::Object ^ state);

public System.Threading.Tasks.Task FromAsync<TArg1,TArg2,TArg3> (Func<TArg1,TArg2,TArg3,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, TArg2 arg2, TArg3 arg3, object? state);

member this.FromAsync : Func<'TArg1, 'TArg2, 'TArg3, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * 'TArg2 * 'TArg3 * obj -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1, TArg2, TArg3) (beginMethod As Func(Of TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, arg2 As TArg2, arg3 As TArg3, state As Object) As Task

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the third argument passed to beginMethod delegate.

TArg3

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,TArg2,TArg3,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

arg3

TArg3

The third argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TResult>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, TArg2, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, TArg2 arg2, System::Object ^ state);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TArg2,TResult> (Func<TArg1,TArg2,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, TArg2 arg2, object? state);

member this.FromAsync : Func<'TArg1, 'TArg2, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * 'TArg2 * obj -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TArg2, TResult) (beginMethod As Func(Of TArg1, TArg2, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, arg2 As TArg2, state As Object) As Task(Of TResult)

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2,TResult>(Func<TArg1,TArg2,AsyncCallback, Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, TArg2, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, TArg2, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, TArg2 arg2, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TArg2,TResult> (Func<TArg1,TArg2,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, TArg2 arg2, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, 'TArg2, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * 'TArg2 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TArg2, TResult) (beginMethod As Func(Of TArg1, TArg2, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, arg2 As TArg2, state As Object, creationOptions As TaskCreationOptions) As Task(Of TResult)

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, Object)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, TArg2, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, TArg2 arg2, System::Object ^ state);

public System.Threading.Tasks.Task FromAsync<TArg1,TArg2> (Func<TArg1,TArg2,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, TArg2 arg2, object? state);

member this.FromAsync : Func<'TArg1, 'TArg2, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * 'TArg2 * obj -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1, TArg2) (beginMethod As Func(Of TArg1, TArg2, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, arg2 As TArg2, state As Object) As Task

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TArg2>(Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, TArg2, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TArg2>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, TArg2, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, TArg2 arg2, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task FromAsync<TArg1,TArg2> (Func<TArg1,TArg2,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, TArg2 arg2, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, 'TArg2, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * 'TArg2 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1, TArg2) (beginMethod As Func(Of TArg1, TArg2, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, arg2 As TArg2, state As Object, creationOptions As TaskCreationOptions) As Task

Type Parameters

TArg1

The type of the second argument passed to beginMethod delegate.

TArg2

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,TArg2,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

arg2

TArg2

The second argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TResult>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, System::Object ^ state);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TResult> (Func<TArg1,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, object? state);

member this.FromAsync : Func<'TArg1, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * obj -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TResult) (beginMethod As Func(Of TArg1, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, state As Object) As Task(Of TResult)

Type Parameters

TArg1

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1,TResult>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, TArg1, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1, typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<TArg1, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, TArg1 arg1, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task<TResult> FromAsync<TArg1,TResult> (Func<TArg1,AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, TArg1 arg1, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * 'TArg1 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TArg1, TResult) (beginMethod As Func(Of TArg1, AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), arg1 As TArg1, state As Object, creationOptions As TaskCreationOptions) As Task(Of TResult)

Type Parameters

TArg1

The type of the first argument passed to the beginMethod delegate.

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<TArg1,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task FromAsync<TArg1> (Func<TArg1,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<'TArg1, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1) (beginMethod As Func(Of TArg1, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, state As Object, creationOptions As TaskCreationOptions) As Task

Type Parameters

TArg1

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TArg1>(Func<TArg1,AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, TArg1, Object)

Source:

TaskFactory.cs

Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TArg1>
 System::Threading::Tasks::Task ^ FromAsync(Func<TArg1, AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Action<IAsyncResult ^> ^ endMethod, TArg1 arg1, System::Object ^ state);

public System.Threading.Tasks.Task FromAsync<TArg1> (Func<TArg1,AsyncCallback,object?,IAsyncResult> beginMethod, Action<IAsyncResult> endMethod, TArg1 arg1, object? state);

member this.FromAsync : Func<'TArg1, AsyncCallback, obj, IAsyncResult> * Action<IAsyncResult> * 'TArg1 * obj -> System.Threading.Tasks.Task

Public Function FromAsync(Of TArg1) (beginMethod As Func(Of TArg1, AsyncCallback, Object, IAsyncResult), endMethod As Action(Of IAsyncResult), arg1 As TArg1, state As Object) As Task

Type Parameters

TArg1

The type of the first argument passed to the beginMethod delegate.

Parameters

beginMethod

Func<TArg1,AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Action<IAsyncResult>

The delegate that ends the asynchronous operation.

arg1

TArg1

The first argument passed to the beginMethod delegate.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task

The created Task that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

The beginMethod delegate is started on the thread that FromAsync is running on. This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions, TaskScheduler)

Source:

TaskFactory.cs

Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.

public:
generic <typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(IAsyncResult ^ asyncResult, Func<IAsyncResult ^, TResult> ^ endMethod, System::Threading::Tasks::TaskCreationOptions creationOptions, System::Threading::Tasks::TaskScheduler ^ scheduler);

public System.Threading.Tasks.Task<TResult> FromAsync<TResult> (IAsyncResult asyncResult, Func<IAsyncResult,TResult> endMethod, System.Threading.Tasks.TaskCreationOptions creationOptions, System.Threading.Tasks.TaskScheduler scheduler);

member this.FromAsync : IAsyncResult * Func<IAsyncResult, 'Result> * System.Threading.Tasks.TaskCreationOptions * System.Threading.Tasks.TaskScheduler -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TResult) (asyncResult As IAsyncResult, endMethod As Func(Of IAsyncResult, TResult), creationOptions As TaskCreationOptions, scheduler As TaskScheduler) As Task(Of TResult)

Type Parameters

TResult

The type of the result available through the task.

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Func<IAsyncResult,TResult>

The function delegate that processes the completed asyncResult.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

scheduler

TaskScheduler

The TaskScheduler that is used to schedule the task that executes the end method.

Returns

Task<TResult>

A Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

-or-

scheduler is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.

public:
generic <typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(IAsyncResult ^ asyncResult, Func<IAsyncResult ^, TResult> ^ endMethod, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task<TResult> FromAsync<TResult> (IAsyncResult asyncResult, Func<IAsyncResult,TResult> endMethod, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : IAsyncResult * Func<IAsyncResult, 'Result> * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TResult) (asyncResult As IAsyncResult, endMethod As Func(Of IAsyncResult, TResult), creationOptions As TaskCreationOptions) As Task(Of TResult)

Type Parameters

TResult

The type of the result available through the task.

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Func<IAsyncResult,TResult>

The function delegate that processes the completed asyncResult.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

Returns

Task<TResult>

A Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TResult>(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, System::Object ^ state);

public System.Threading.Tasks.Task<TResult> FromAsync<TResult> (Func<AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, object? state);

member this.FromAsync : Func<AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * obj -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TResult) (beginMethod As Func(Of AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), state As Object) As Task(Of TResult)

Type Parameters

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

state

Object

An object containing data to be used by the beginMethod delegate.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

Remarks

This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns

FromAsync<TResult>(IAsyncResult, Func<IAsyncResult,TResult>)

Source:

TaskFactory.cs

Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.

public:
generic <typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(IAsyncResult ^ asyncResult, Func<IAsyncResult ^, TResult> ^ endMethod);

public System.Threading.Tasks.Task<TResult> FromAsync<TResult> (IAsyncResult asyncResult, Func<IAsyncResult,TResult> endMethod);

member this.FromAsync : IAsyncResult * Func<IAsyncResult, 'Result> -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TResult) (asyncResult As IAsyncResult, endMethod As Func(Of IAsyncResult, TResult)) As Task(Of TResult)

Type Parameters

TResult

The type of the result available through the task.

Parameters

asyncResult

IAsyncResult

The IAsyncResult whose completion should trigger the processing of the endMethod.

endMethod

Func<IAsyncResult,TResult>

The function delegate that processes the completed asyncResult.

Returns

Task<TResult>

A Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

asyncResult is null.

-or-

endMethod is null.

Remarks

Tip

The FromAsync overloads that take an asyncResult parameter are not as efficient as the overloads that take a beginMethod parameter. If performance is an issue, use the overloads that provide the beginMethod/endMethod pattern.

See also

• Task Parallel Library (TPL)
• Chaining Tasks by Using Continuation Tasks
• Task Cancellation

FromAsync<TResult>(Func<AsyncCallback,Object,IAsyncResult>, Func<IAsyncResult,TResult>, Object, TaskCreationOptions)

Source:

TaskFactory.cs

Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.

public:
generic <typename TResult>
 System::Threading::Tasks::Task<TResult> ^ FromAsync(Func<AsyncCallback ^, System::Object ^, IAsyncResult ^> ^ beginMethod, Func<IAsyncResult ^, TResult> ^ endMethod, System::Object ^ state, System::Threading::Tasks::TaskCreationOptions creationOptions);

public System.Threading.Tasks.Task<TResult> FromAsync<TResult> (Func<AsyncCallback,object?,IAsyncResult> beginMethod, Func<IAsyncResult,TResult> endMethod, object? state, System.Threading.Tasks.TaskCreationOptions creationOptions);

member this.FromAsync : Func<AsyncCallback, obj, IAsyncResult> * Func<IAsyncResult, 'Result> * obj * System.Threading.Tasks.TaskCreationOptions -> System.Threading.Tasks.Task<'Result>

Public Function FromAsync(Of TResult) (beginMethod As Func(Of AsyncCallback, Object, IAsyncResult), endMethod As Func(Of IAsyncResult, TResult), state As Object, creationOptions As TaskCreationOptions) As Task(Of TResult)

Type Parameters

TResult

The type of the result available through the task.

Parameters

beginMethod

Func<AsyncCallback,Object,IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod

Func<IAsyncResult,TResult>

The delegate that ends the asynchronous operation.

state

Object

An object containing data to be used by the beginMethod delegate.

creationOptions

TaskCreationOptions

The TaskCreationOptions value that controls the behavior of the created Task<TResult>.

Returns

Task<TResult>

The created Task<TResult> that represents the asynchronous operation.

Exceptions

ArgumentNullException

beginMethod is null.

-or-

endMethod is null.

ArgumentOutOfRangeException

creationOptions specifies an invalid TaskCreationOptions value. For more information, see the Remarks for FromAsync(Func<AsyncCallback,Object,IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions)

Remarks

This method throws any exceptions thrown by the beginMethod.

See also

• Task Parallel Library (TPL)
• Using TPL with Other Asynchronous Patterns