EssRenameGroup
Description
EssRenameGroup() renames an existing group.
Syntax
ESS_FUNC_M EssRenameGroup (hCtx, OldName, NewName);
ESS_HCTX_T | hCtx |
ESS_STR_T | OldName |
ESS_STR_T | NewName |
Parameters
hCtx | Essbase API context handle. |
OldName | Old name of existing group to rename. Group names can be up to 30 characters long.
|
NewName | New name for renamed group. |
Return Value
None.
Notes
- The specified new group name must not already exist.
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_RenameGroup (ESS_HCTX_T hCtx)
{
ESS_FUNC_M sts = ESS_STS_NOERR;
ESS_STR_T OldName;
ESS_STR_T NewName;
OldName = "PowerUsers";
NewName = "PowerGroup";
sts = EssRenameGroup (hCtx, OldName, NewName);
return (sts);
}
See Also
EssCreateGroup()
EssDeleteGroup()
EssListGroups()