Runs the execute function to assign new members to an Access Control Group.

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

Syntax

C#
public static bool AssignToAccessControlGroup(
	ConfigurationManager configurationManager,
	AccessControlGroup accessControlGroup,
	IEnumerable<ConfigurationId> newMembers,
	AccessControlGroupObjectType objectType,
	int transactionId
)
Visual Basic
Public Shared Function AssignToAccessControlGroup ( _
	configurationManager As ConfigurationManager, _
	accessControlGroup As AccessControlGroup, _
	newMembers As IEnumerable(Of ConfigurationId), _
	objectType As AccessControlGroupObjectType, _
	transactionId As Integer _
) As Boolean

Parameters

configurationManager
Type: ININ.IceLib.Configuration..::..ConfigurationManager
A Configuration Manager instance.
accessControlGroup
Type: ININ.IceLib.Configuration.DataTypes..::..AccessControlGroup
The access control group to assign the new members to.
newMembers
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'ConfigurationId>)>)>
A list of new members.
objectType
Type: ININ.IceLib.Configuration.DataTypes..::..AccessControlGroupObjectType
The type of the object being assigned.
transactionId
Type: System..::..Int32
The transaction ID.

Return Value

trueTruetruetrue (True in Visual Basic) if they are being used, otherwise falseFalsefalsefalse (False in Visual Basic).

Remarks

Valid values for transactionId are obtained from a call to BeginTransaction()()()() or BeginTransactionAsync(EventHandler<(Of <<'(BeginTransactionCompletedEventArgs>)>>), Object). If a valid transaction ID is set, notifications for watched configuration objects will be suspended until a call to EndTransaction(Int32) or EndTransactionAsync(Int32, AsyncCompletedEventHandler, Object) is made with the associated transaction ID.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionAn empty new members list was provided.
System..::..ArgumentOutOfRangeException Invalid AccessControlGroupObjectType was provided, or transactionId 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