# EssSetGroup

Description

EssSetGroup() sets a group information structure, which contains security information for the group.

Syntax

    ESS_FUNC_M EssSetGroup (hCtx, pGroupInfo);

ESS_HCTX_T | hCtx
ESS_PGROUPINFO_T | pGroupInfo

Parameters

hCtx | Essbase API context handle.
pGroupInfo | Pointer to group info structure.

Return Value

None.

Notes

- The name of the group to set is a field in the group info structure, which must always be specified.
- The only field in the group info structure which may be changed using this function is the Access field (the other fields are used for users of for information only). See the description of the ESS_GROUPINFO_T structure for more information.

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_SetGroup (ESS_HCTX_T  hCtx)
    {
       ESS_FUNC_M        sts  = ESS_STS_NOERR;
       ESS_USERINFO_T   Group;

       strcpy(Group.Name,"PowerUsers");
       strcpy(Group.AppName,"Sample");
       strcpy(Group.DbName,"Basic");
       Group.Access = ESS_ACCESS_SUPER;

       sts = EssSetGroup(hCtx, &Group);
       return (sts);
    }

See Also

EssGetGroup()
EssListGroups()