EssSetGroupList

Sets the list of users who are members of a group.

Syntax

ESS_FUNC_M  EssSetGroupList (hCtx, GroupName, Count, pUserList);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
GroupName	ESS_STR_T	Group name or user name.
Count	ESS_USHORT_T	Count of user names.
pUserList	ESS_PUSERNAME_T	Pointer to an array of user name strings.

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 GroupName argument and passing a list of groups as the pUserList 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. To bypass this restriction, use MaxL for adding users to groups.

Return Value

None.

Access

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

Example

ESS_FUNC_M
ESS_SetGroupList (ESS_HCTX_T  hCtx)
{
   ESS_FUNC_M        sts = ESS_STS_NOERR;
   ESS_USERNAME_T   UserList[3];
   ESS_USHORT_T     Count;
   ESS_STR_T        GroupName;
   GroupName = "Powerusers";
   strcpy(UserList[0],"App Designer");  
   strcpy(UserList[1],"Db Designer");  
   strcpy(UserList[2],"User Creator"); 
   Count = 3;
   
   sts = EssSetGroupList (hCtx, GroupName, Count,
         UserList);  
   return (sts);
}