# EsbGetGroup

Description

EsbGetGroup() gets a group information structure, which contains security information for the group.

Syntax

    EsbGetGroup (hCtx, GrpName, pUserInfo)

    ByVal hCtx      As Long
    ByVal GrpName   As String
          pUserInfo As ESB_USERINFO_T

Parameters

hCtx | Essbase VB API context handle.
GrpName | Group name.
pUserInfo | Buffer to receive a group info structure.

Return Value

If successful, returns the group information structure in pGroupInfo.

Access

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

Example

    Declare Function EsbGetGroup Lib "ESBAPIW" (ByVal hCtx As Long, ByVal GroupName As String, UserInfo As ESB_USERINFO_T) As Long
    Sub ESB_GetGroup ()
       Dim sts As Long
       Dim GroupName As String
       Dim GroupInfo As ESB_USERINFO_T

       GroupName = "PowerUsers"

       '************************
       ' Get GroupInfo structure
       '************************
       sts = EsbGetGroup (hCtx, GroupName, GroupInfo)
    End Sub

See Also

EsbListGroups()
EsbSetGroup()