# EssDeleteGroup

Description

EssDeleteGroup() deletes an existing group.

Syntax

    ESS_FUNC_M EssDeleteGroup (hCtx, GroupName);

ESS_HCTX_T | hCtx
ESS_STR_T | GroupName

Parameters

hCtx | Essbase API context handle.
GroupName | Name of group to delete.

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_DeleteGroup (ESS_HCTX_T  hCtx)
    {
       ESS_FUNC_M     sts = ESS_STS_NOERR;
       ESS_STR_T     GroupName;
       GroupName = "PowerUsers";

       sts = EssDeleteGroup (hCtx, GroupName);

       return (sts);
    }

See Also

EssCreateGroup()
EssListGroups()
EssRenameGroup()