Executes a transaction synchronously. Caller is blocked until results are returned from the transaction execution.

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

Syntax

C#
public bool Execute(
	ref TransactionData transactionData
)
Visual Basic
Public Function Execute ( _
	ByRef transactionData As TransactionData _
) As Boolean

Parameters

transactionData
Type: ININ.IceLib.Data.TransactionBuilder..::..TransactionData%
A TransactionData object that holds information about the transaction being executed.

Return Value

trueTruetruetrue (True in Visual Basic) if the transaction completed successfully; falseFalsefalsefalse (False in Visual Basic) otherwise.

Remarks

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 this method returns, 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.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
ININ.IceLib..::..IceLibLicenseExceptionThe client does not have the license required to perform this operation.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

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