EsbDisplayAlias

Description

EsbDisplayAlias() displays the contents of an alias table in the active database.

Syntax
EsbDisplayAlias (hCtx, AltName, pItems)
ByVal hCtx    As Long
ByVal AltName As String
      pItems  As Integer

Parameters

hCtxEssbase VB API context handle.
AltNameName of alias table.
pItemsAddress of variable to receive Items of aliases.

Return Value

This function returns the number of alias names in the table and generates an array of MBRALT structures accessible via EsbGetNextItem().

Notes

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 EsbDisplayAlias Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Name As String, Items As Integer) As Long

Sub ESB_DisplayAlias ()
   Dim pItems As Integer
   Dim Name As String
   Dim MbrAlt As ESB_MBRALT_T
   Dim sts As Long

   Name = "Default"

   '**************
   ' Display Alias
   '************** 
   sts = EsbDisplayAlias (hCtx, Name,
   pItems)

   For n = 1 To Items

     '***************************
     ' Get next Member/Alias Name 
     ' combination from the list
     '*************************** 
     sts = EsbGetNextItem (hCtx, 
     ESB_MBRALT_TYPE, MbrAlt)
   Next
End Sub

See Also

EsbListAliases()
EsbGetNextItem()