Asynchronously cancels the transaction associated with the supplied transaction token.
Namespace: ININ.IceLib.Data.TransactionBuilderAssembly: ININ.IceLib.Data.TransactionBuilder (in ININ.IceLib.Data.TransactionBuilder.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void CancelTransactionAsync( string transactionToken, EventHandler<CancelTransactionCompletedEventArgs> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub CancelTransactionAsync ( _ transactionToken As String, _ completedCallback As EventHandler(Of CancelTransactionCompletedEventArgs), _ userState As Object _ ) |
Parameters
- transactionToken
- Type: System..::..String
The transaction token associated with the transaction to cancel.
- completedCallback
- Type: System..::..EventHandler<(Of <(<'CancelTransactionCompletedEventArgs>)>)>
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
The CompletedAction should be set and will be raised when the transaction is cancelled.
When raised, the Cancelled property of the ExecuteCompletedEventArgs instance will be set to trueTruetruetrue (True in Visual Basic).
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.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A parameter is Empty. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.