# EsbListObjects

Description

EsbListObjects() lists all objects of the specified types on the server or locally on the client.

Syntax

    EsbListObjects (hCtx, ObjType, AppName, DbName, pItems)

    ByVal hCtx    As Long
    ByVal ObjType As Long
    ByVal AppName As String
    ByVal DbName  As String
          pItems  As Integer

Parameters

hCtx | Essbase VB API context handle. Can be local context handle returned from EsbCreateLocalContext().
ObjType | Object type (may be multiple types). Refer to "Bitmask Types" for a list of possible values.
AppName | Application name.
DbName | Database name. If an empty string, lists objects in the application sub-directory.
pItems | Address of variable to receive the Items of objects of the appropriate type(s).

Return Value

If successful, returns a Items of the number of objects of the appropriate type(s) in pItems, and generates an array of matching object structures accessible via EsbGetNextItem().

Access

This function requires no special privileges; note however that server objects will only be listed if the caller has the appropriate level of access to the application and/or database (depending on the object type).

Example

    Declare Function EsbListObjects Lib "ESBAPIW" (ByVal hCtx As Long, ByVal ObjType As Integer, ByVal AppName As String, ByVal DbName As String, Items As Integer) As Long

    Sub ESB_ListObjects ()
       Dim Items As Integer
       Dim AppName As String
       Dim DbName As String
       Dim ObjType As Integer
       Dim ObjInfo As ESB_OBJINFO_T
       Dim sts As Long

       Appname = "Sample"
       DbName = "Basic"
       ObjType = ESB_OBJTYPE_OUTLINE

       '*********************
       ' List Outline Objects
       '*********************
       sts = EsbListObjects (hCtx, ObjType,
             AppName, DbName, Items)

       For n = 1 To Items

         '**************************
         ' Get next Object Structure
         ' from the list
         '**************************
         sts = EsbGetNextItem (hCtx,
               ESB_OBJINFO_TYPE, ObjInfo)
       Next
    End Sub

See Also

EsbGetObject()
EsbGetObjectInfo()
EsbGetNextItem()