Begins a 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 int BeginTransaction()
Visual Basic
Public Function BeginTransaction As Integer

Return Value

The transaction ID.

Remarks

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.

Exceptions

ExceptionCondition
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