[This is preliminary documentation and is subject to change.]

Adds users to a particular group.

Namespace:  OfficeClip.DBLayer.Account
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public int AddUsersToGroup(
	string userList,
	int groupId,
	int userId,
	ref int[] statuses,
	ref string[] names,
	ref string[] emailAddresses,
	ref string[] ldapAccountNames
)
Visual Basic (Declaration)
Public Function AddUsersToGroup ( _
	userList As String, _
	groupId As Integer, _
	userId As Integer, _
	ByRef statuses As Integer(), _
	ByRef names As String(), _
	ByRef emailAddresses As String(), _
	ByRef ldapAccountNames As String() _
) As Integer
Visual C++
public:
int AddUsersToGroup(
	String^ userList, 
	int groupId, 
	int userId, 
	array<int>^% statuses, 
	array<String^>^% names, 
	array<String^>^% emailAddresses, 
	array<String^>^% ldapAccountNames
)

Parameters

userList
Type: System..::.String
The list of comma separated userDetailIds to be added to a particular group.
groupId
Type: System..::.Int32
The group id of the group where the users are to be invited/added.
userId
Type: System..::.Int32
The unique id of the current user
statuses
Type: array<System..::.Int32>[]()[]%
Array of statuses
names
Type: array<System..::.String>[]()[]%
Array of names
emailAddresses
Type: array<System..::.String>[]()[]%
The email address
ldapAccountNames
Type: array<System..::.String>[]()[]%
The LDAP account names

Return Value

0 if successful -1 The member being added already belongs to this group or organization. -2 if any of the invited users could not be added because an email could not be sent. -3 if any of the invited users could not be added because an alert could be created. -4 The member can not be added/invited because accounting is enabled and the account where the user should belong could not be determined. -5 The member can not be added/invited because accounting is enabled and the user already belongs to another account. -6 The member can not be added/invited because accounting is enabled and the account has reached the number of users Limit. -7 The member can not be added because the site license user Limit has been reached.

See Also