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 CancelTransaction( string transactionToken ) |
Visual Basic |
---|
Public Sub CancelTransaction ( _ transactionToken As String _ ) |
Parameters
- transactionToken
- Type: System..::..String
The transaction token associated with the transaction to cancel.
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).
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.