# EsbListUsersEx

Description

EsbListUsersEx() lists all users who have access to a particular Essbase server, application or database. This function operates similar to EsbListUsers(), with the addition of the security protocol parameter.

Syntax

    Declare Function EsbListUsersEx Lib "esbapin" (
    ByVal hCtx As Long,
    ByVal AppName As String,
    ByVal DbName As String,
    ByVal Protocol As String,
          pItems As Integer) As Long

Parameters

hCtx | The Essbase API context handle.
AppName | The Application name. If NULL, lists all users.
DbName | The database name. If NULL, lists users for all databases within application.
Protocol | The name of the external authentication security protocol mechanism.
pItems | The count of users.

Return Value

If successful, returns a count of the number of users in pCount, and list of users with access to the specified application and database in ppUserList.

Notes

- If both AppName and DbName are not NULL, only users with access to the specified application and database are listed. If DbName is NULL, only users with access to the specified application are listed. If AppName is NULL, all users that exist on the server are listed.
- The list of users with access to the specified application and database is returned as a list of ESB_USERINFOEX_T structures. The AppName and DbName fields of these returned user info structures contain NULL values. The list of structures is accessed by calling EsbGetNextItem().

Access

This function requires no special privileges.

Example

See Also