AsyncHelperBeginOperationTResult(FuncIAsyncContext, TResult, TResult, AsyncConfig, String) Method

Exposes the specified operation with a return value as an IAsyncResult-returning async operation. To obtain the result the EndOperation method must be called.
See the Examples section of the AsyncHelper class for details.

Definition

Namespace: KGySoft.Threading
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0

C#

public static IAsyncResult BeginOperation<TResult>(
	Func<IAsyncContext, TResult> operation,
	TResult canceledResult,
	AsyncConfig? asyncConfig,
	string beginMethodName = null
)

VB

Public Shared Function BeginOperation(Of TResult) ( 
	operation As Func(Of IAsyncContext, TResult),
	canceledResult As TResult,
	asyncConfig As AsyncConfig,
	Optional beginMethodName As String = Nothing
) As IAsyncResult

C++

public:
generic<typename TResult>
static IAsyncResult^ BeginOperation(
	Func<IAsyncContext^, TResult>^ operation, 
	TResult canceledResult, 
	AsyncConfig^ asyncConfig, 
	String^ beginMethodName = nullptr
)

F#

static member BeginOperation : 
        operation : Func<IAsyncContext, 'TResult> * 
        canceledResult : 'TResult * 
        asyncConfig : AsyncConfig * 
        ?beginMethodName : string 
(* Defaults:
        let _beginMethodName = defaultArg beginMethodName null
*)
-> IAsyncResult

Parameters

operation FuncIAsyncContext, TResult: The operation to be executed.
canceledResult TResult: The result to be returned by EndOperation if the operation is canceled and ThrowIfCanceled of asyncConfig returns .
asyncConfig AsyncConfig: The configuration for the asynchronous operation.
beginMethodName String (Optional): The name of the method that represents the operation. This must be passed also to the EndOperation method. This parameter is optional.
Default value: The name of the caller method when used with a compiler that recognizes CallerMemberNameAttribute; otherwise, .

Type Parameters

TResult: The type of the result of the specified operation.

Return Value

IAsyncResult
An IAsyncResult instance representing the asynchronous operation. To complete the operation it must be passed to the EndOperation method.

Exceptions

ArgumentNullException

operation or beginMethodName is .