# EsbCreateGroup

Description

EsbCreateGroup() creates a new group.

Syntax

    EsbCreateGroup (hCtx, GrpName)

    ByVal hCtx    As Long
    ByVal GrpName As String

Parameters

hCtx | Essbase VB API context handle.
GrpName | Name of a group to create. Group names can be up to 30 characters long, and can contain all special characters allowed in DOS file names. No spaces, commas, tabs, slashes, backslashes, or periods are allowed. The use of some special characters is not recommended because they are often used by the operating system (for example, @, $, %, !, and &).

Return Value

None.

Notes

- The specified group must not already exist.
- The group's access level may be set with the EsbSetGroup() function.

Access

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

Example

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

    Sub ESB_CreateGroup ()
       Dim sts As Long
       Dim GroupName As String

       GroupName = "PowerUsers"

       '*************
       ' Create Group
       '*************
       sts = EsbCreateGroup (hCtx, GroupName)
    End Sub

See Also

EsbDeleteGroup()
EsbListGroups()
EsbRenameGroup()
EsbSetGroup()