Asynchronously executes a transaction.

Namespace: ININ.IceLib.Data.TransactionBuilder
Assembly: ININ.IceLib.Data.TransactionBuilder (in ININ.IceLib.Data.TransactionBuilder.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void ExecuteAsync(
	TransactionData transactionData,
	EventHandler<ExecuteCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub ExecuteAsync ( _
	transactionData As TransactionData, _
	completedCallback As EventHandler(Of ExecuteCompletedEventArgs), _
	userState As Object _
)

Parameters

transactionData
Type: ININ.IceLib.Data.TransactionBuilder..::..TransactionData
A TransactionData object that holds information about the transaction being executed.
completedCallback
Type: System..::..EventHandler<(Of <(<'ExecuteCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

See ResultSet for an explanation of how transaction information is populated in the transactionData parameter.

If the CompletedAction is set, then the transaction data will not be available until the CompletedAction is invoked. When ForceOutOfBand is set to true, and the CompletedAction is set, the TransactionToken will be set when the completedCallback is invoked, and can be used in conjunction with CancelTransaction(String), CancelTransactionAsync(String, EventHandler<(Of <<'(CancelTransactionCompletedEventArgs>)>>), Object), QueryTransactionStatus(String) or QueryTransactionStatus(String) to cancel or track the status of the transaction.

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also