# EsbListApplications

Description

EsbListApplications() lists all applications which are accessible to the caller.

Syntax

    EsbListApplications (hCtx, pItems)

    ByVal hCtx   As Long
          pItems As Integer

Parameters

hCtx | Essbase VB API context handle.
pItems | Address of variable to receive Items of returned applications.

Return Value

If successful, this function returns a Items of the number of accessible applications in pItems, and generates a list of application name strings accessible via EsbGetNextItem(). There are 'Items' number of items in the list.

Access

This function requires no special privileges; note however that server applications will only be listed if the caller has access to them.

Example

    Declare Function EsbListApplications Lib "ESBAPIW" (ByVal hCtx As Long, Items As Integer) As Long

    Sub ESB_ListApplications ()
       Dim sts As Long
       Dim Items As Integer
       Dim AppName As String * ESB_APPNAMELEN

       '******************************
       ' Get List of Application names
       '******************************
       sts = EsbListApplications (hCtx, Items)

       For n = 1 To Items

         '*********************************
         ' Get next Application name string
         '*********************************
         sts = EsbGetNextItem (hCtx,
               ESB_APPNAME_TYPE, ByVal AppName)
       Next
    End Sub

See Also

EsbListDatabases()
EsbListObjects()
EsbGetNextItem()