EssSetGroupListEx

Sets the list of users who are members of a group. Similar to EssSetGroupList, but can accept a user directory specification or unique identity attribute for EntityId.

Syntax

ESS_FUNC_M EssSetGroupListEx (hCtx, EntityId, bIsIdentity, entityType, Count, pIdList, bUsingIdentity);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle (input).

EntityId

ESS_STR_T

User or group name (input). Can be specified as name@provider or as a unique identity attribute.

bIsIdentity

ESS_BOOL_T

Input. Indicates if EntityId is a name or an identity. If TRUE, EntityId is an identity.

entityType

ESS_USHORT_T

Input. Indicates if EntityId is a group or a user. If specified as user, then the list can consist of only groups. If specified as group, then the list can contain only groups in native security mode. but in EPM System security mode, the list can consist of both users and groups.

Count

ESS_USHORT_T

Count of identities (input).

pIdList

ESS_PSTR_T

Pointer to an array of identities (input).

bUsingIdentity

ESS_BOOL_T

Input. Indicates if EntityId is a name or an identity. If TRUE, EntityId is an identity.

Notes

This function can also be used to set the list of groups to which a user belongs by using a user name as the EntityID argument and passing a list of groups as the pUserIDList argument.

An administrator that is not an Essbase administrator, in order to administer privileges on users and groups, must have higher privileges than those users and groups on the applications on which they are administering access.

Return Value

None.

Access

This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Example

See Also