# EsbDeleteFromGroup

Description

EsbDeleteFromGroup() removes a user from the list of group members.

Syntax

    EsbDeleteFromGroup (hCtx, GrpName, User)

    ByVal hCtx    As Long
    ByVal GrpName As String
    ByVal User    As String

Parameters

hCtx | Essbase VB API context handle.
GrpName | Group name.
User | Name of a user to remove from the group list.

Return Value

None.

Notes

- As well as deleting the specified user from the list of members for the specified group, this function also deletes the group from the user's own list of associated groups.

Access

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

Example

    Declare Function EsbDeleteFromGroup Lib "ESBAPIW" (ByVal hCtx As Long, ByVal GroupName As String, ByVal User As String) As Long

    Sub ESB_DeleteFromGroup ()
       Dim sts As Long
       Dim GroupName As String
       Dim User As String

       GroupName = "PowerUsers"
       User = "Jim Smith"
       '***********************
       ' Delete user from group
       '***********************
       sts = EsbDeleteFromGroup (hCtx, GroupName, User)
    End Sub

See Also

EsbAddToGroup()
EsbGetGroupList()
EsbListGroups()
EsbSetGroupList()