# EssCreateGroup

Description

EssCreateGroup() creates a new group.

Syntax

    ESS_FUNC_M EssCreateGroup (hCtx, GroupName);

ESS_HCTX_T | hCtx
ESS_STR_T | GroupName

Parameters

hCtx | Essbase API context handle.
GroupName | Name of group to create. Group names can be up to 30 characters long, and can contain all special characters allowed in DOS file names. No spaces, commas, tabs, slashes, backslashes, or periods are allowed. The use of some special characters is not recommended because they are often used by the operating system (for example, @, $, %, !, and &).

Return Value

None.

Notes

- The specified group must not already exist.
- The group's access level may be set with the EssSetGroup() function.

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

       sts = EssCreateGroup (hCtx, GroupName);

       return (sts);
    }

See Also

EssDeleteGroup()
EssListGroups()
EssRenameGroup()
EssSetGroup()