Ends the configuration transaction.

Namespace: ININ.IceLib.Configuration
Assembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (21.2.0.218)

Syntax

C#
public void EndTransactionAsync(
	int transactionId,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub EndTransactionAsync ( _
	transactionId As Integer, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

transactionId
Type: System..::..Int32
The transaction ID.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
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.

Valid values can be obtained from a call to BeginTransaction()()()() or BeginTransactionAsync(EventHandler<(Of <<'(BeginTransactionCompletedEventArgs>)>>), Object). If the connected Session is disconnected before EndTransaction(Int32) or EndTransactionAsync(Int32, AsyncCompletedEventHandler, Object) is called, all transaction IDs will become invalid, and new ones will need to be obtained.

A call to this method will cause notifications for watched UserConfiguration objects to be fired for all changes that would have affected a watched UserConfiguration object made while inside the transaction.

Currently, the DefaultUserConfiguration, UserConfiguration, RoleConfiguration, and WorkgroupConfiguration objects are the only ones that support using transactions. Additionally, the AssignToAccessControlGroup(ConfigurationManager, AccessControlGroup, IEnumerable<(Of <<'(ConfigurationId>)>>), AccessControlGroupObjectType, Int32) method also supports transactions.

Exceptions

ExceptionCondition
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ArgumentOutOfRangeExceptiontransactionId is less than or equal to zero.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 SU 5 and beyond.

See Also