# EsbListAliases

Description

EsbListAliases() lists all the alias table names in the active database.

Syntax

    EsbListAliases (hCtx, pItems)

    ByVal hCtx   As Long
          pItems As Integer

Parameters

hCtx | Essbase VB API context handle.
pItems | Address of variable to receive Items of alias tables.

Return Value

If successful, this function returns a Items of alias tables in pItems, and generates an array of alias table names accessible via EsbGetNextItem().

Access

This function requires the caller to have access to the database, and to have selected it as their active database using EsbSetActive().

Example

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

    Sub ESB_ListAliases ()
       Dim Items As Integer
       Dim AliasName As String * ESB_ALIASNAMELEN
       Dim sts As Long
       '*************
       ' List Aliases
       '*************
       sts = EsbListAliases (hCtx, Items)

       For n = 1 To Items
         '********************
         ' Get next Alias Name
         ' from the list
         '********************
         sts = EsbGetNextItem (hCtx,
               ESB_ALIASNAME_TYPE, ByVal AliasName)
       Next
    End Sub

See Also

EsbDisplayAlias()
EsbGetNextItem()