TrusteeRegisterGroup Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Registers or updates a group (role) account in Content Studio.

Namespace: ContentStudio.Security
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

protected static int RegisterGroup(
	int connectionId,
	int sessionId,
	int groupId,
	SecurityIdentifier sid,
	string domain,
	string groupName,
	string description,
	bool isLocalGroup
)

Parameters

connectionId
Type: SystemInt32
A value that identifies the web site
sessionId
Type: SystemInt32
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
groupId
Type: SystemInt32
The id of a group to update. Pass zero to register a new group.
sid
Type: System.Security.PrincipalSecurityIdentifier
The group's security identifier. This parameter is ignored if a valid GroupID is passed in.
domain
Type: SystemString
The name of the domain that the group belongs to. The Domain and GroupName parameter must be unique in combination. This value cannot exceed MAX_DOMAINNAME_LENGTH characters.
groupName
Type: SystemString
The groups name. The Domain and GroupName parameter must be unique in combination. This value cannot exceed MAX_TRUSTEENAME_LENGTH characters.
description
Type: SystemString
A short description of the group. This value cannot exceed MAX_DESCRIPTION_LENGTH characters.
isLocalGroup
Type: SystemBoolean
This value indicates that the group is local to the Content Studio server.

Return Value

Type: Int32
A value that identifies the group
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Remarks

External inheriting classes can use this method to register any group account whether it exists in the network or not as long it has been given a unique and valid SID.
See Also

Reference