Asynchronously begins a configuration transaction.

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


public void BeginTransactionAsync(
	EventHandler<BeginTransactionCompletedEventArgs> completedCallback,
	Object userState
Visual Basic
Public Sub BeginTransactionAsync ( _
	completedCallback As EventHandler(Of BeginTransactionCompletedEventArgs), _
	userState As Object _


Type: System..::..EventHandler<(Of <(<'BeginTransactionCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
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.


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.

The transaction ID can be set on supporting configuration objects by calling the appropriate SetTransactionId() method. If a transaction ID is set, notifications for watched UserConfiguration objects will be suspended until EndTransaction(Int32) is called. 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.

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.


ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.

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