# EsbSetGroup

Description

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

Syntax

    EsbSetGroup (hCtx, pUserInfo)

    ByVal hCtx      As Long
          pUserInfo As ESB_USERINFO_T

Parameters

hCtx | Essbase VB API context handle.
pUserInfo | 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 ESB_GROUPINFO_T structure for more information.

Access

This function requires the caller to have Create/Delete User privilege (ESB_PRIV_USERCREATE) for the logged in server.

Example

    Declare Function EsbSetGroup Lib "ESBAPIW" (ByVal hCtx As Long, GroupInfo As ESB_USERINFO_T) As Long

    Sub ESB_SetGroup ()
       Dim sts As Long
       Dim GroupInfo As ESB_USERINFO_T

       '*******************************
       ' Initialize GroupInfo structure
       '*******************************
       GroupInfo.Name = "PowerUsers"
       GroupInfo.Type = ESB_TYPE_GROUP
       GroupInfo.Access = ESB_PRIV_APPCREATE
       GroupInfo.MaxAccess = ESB_PRIV_APPCREATE '************************
       ' Set GroupInfo structure
       '************************
       sts = EsbSetGroup (hCtx, GroupInfo)
    End Sub

See Also

EsbGetGroup()
EsbListGroups()