FromAsync(TArg1, TResult) Method (Func(TArg1, AsyncCallback, Object, IAsyncResult), Func(IAsyncResult, TResult), TArg1, Object, TaskCreationOptions)
TOC
Collapse the table of content
Expand the table of content

TaskFactory.FromAsync<'TArg1, 'TResult> Method (Func<'TArg1, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, 'TResult>, 'TArg1, Object, TaskCreationOptions)

.NET Framework (current version)
 

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

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

member FromAsync<'TArg1, 'TResult> : 
        beginMethod:Func<'TArg1, AsyncCallback, Object, IAsyncResult> *
        endMethod:Func<IAsyncResult, 'TResult> *
        arg1:'TArg1 *
        state:Object *
        creationOptions:TaskCreationOptions -> Task<'TResult>

Parameters

beginMethod
Type: System.Func<'TArg1, AsyncCallback, Object, IAsyncResult>

The delegate that begins the asynchronous operation.

endMethod
Type: System.Func<IAsyncResult, 'TResult>

The delegate that ends the asynchronous operation.

arg1
Type: TArg1

The first argument passed to the beginMethod delegate.

state
Type: System.Object

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

creationOptions
Type: System.Threading.Tasks.TaskCreationOptions

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

Return Value

Type: System.Threading.Tasks.Task<'TResult>

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

Type Parameters

TArg1

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

TResult

The type of the result available through the Task<'TResult>.

Exception Condition
ArgumentNullException

The exception that is thrown when the beginMethod argument is null.

-or-

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

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

Universal Windows Platform
Available since 4.5
.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
Return to top
Show:
© 2016 Microsoft