EssSetGroupList
Description
EssSetGroupList() sets the list of users who are members
of a group.
Syntax
ESS_FUNC_M EssSetGroupList (hCtx, GroupName, Count, pUserList);
ESS_HCTX_T | hCtx |
ESS_STR_T | GroupName |
ESS_USHORT_T | Count |
ESS_PUSERNAME_T | pUserList |
Parameters
hCtx | Essbase API context handle. |
GroupName | Group name or user name. |
Count | Count of user names. |
pUserList | Pointer to an array of user name strings.
|
Return Value
None.
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.
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);
}
See Also
EssAddToGroup()
EssDeleteFromGroup()
EssListGroups()