# EsbSetGroupList

Description

EsbSetGroupList() sets the list of users who are members of a group.

Syntax

    EsbSetGroupList (hCtx, GrpName, GrpList, Items)

    ByVal hCtx    As Long
    ByVal GrpName As String
    ByVal GrpList As String
    ByVal Items   As Integer

Parameters

hCtx | Essbase VB API context handle.
GrpName | Group or user name.
GrpList | String of user names (EOL, CR delimited), must be less than 64 KBytes in length.
Items | Items of user names.

Return Value

None.

Notes

- To set the list of groups to which a user belongs, enter a user name as the GroupName argument and pass a list of groups as the UserList argument.

Access

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

Example

    Declare Function EsbSetGroupList Lib "ESBAPIW" (ByVal hCtx As Long, ByVal GroupName As String, ByVal UserList As String, ByVal Items As Integer) As Long

    Sub ESB_SetGroupList ()
       Dim sts As Long
       Dim GroupName As String
       Dim UserList As String
       Dim Items As Integer
       Dim CRLF As String
       CRLF = Chr$(13) + Chr$(10)
       GroupName = "PowerUsers"

       '******************************
       ' Initialize UserList and Items
       '******************************
       Items = 2
       UserList = "Admin" + CRLF + "Bob" '***************
       ' Set Group List
       '***************
       sts = EsbSetGroupList (hCtx, GroupName, UserList, Items)
    End Sub

See Also

EsbAddToGroup()
EsbDeleteFromGroup()
EsbListGroups()
EsbSetGroupList()