EssRenameGroup

Renames an existing group.

Syntax

ESS_FUNC_M  EssRenameGroup (hCtx, OldName, NewName);
ParameterData TypeDescription

hCtx

ESS_HCTX_T

API context handle.

OldName

ESS_STR_T

Old name of existing group to rename.

NewName

ESS_STR_T

New name for renamed group. See Group Name Limits.

Notes

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_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