EsbListCurrencyDatabases

Description

EsbListCurrencyDatabases() lists all currency databases within a specific application which are accessible to the caller.

Syntax
EsbListCurrencyDatabases (hCtx, AppName, pItems)
ByVal hCtx    As Long
ByVal AppName As String
      pItems  As Integer

Parameters

hCtxEssbase VB API context handle.
AppNameApplication name.
pItemsAddress of variable to receive Items of currency databases.

Return Value

If successful, this function returns a Items of the number of accessible currency databases in pItems, and generates a list of applications/currency database names that is accessible via EsbGetNextItem().

Notes

Access

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

Example

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

Sub ESB_ListCurrencyDatabases ()
   Dim Items As Integer
   Dim AppName As String
   Dim AppDb As ESB_APPDB_T 
   Dim sts As Long

   AppName = "Sample"

   '************************
   ' List Currency Databases
   '************************ 
   sts = EsbListCurrencyDatabases (hCtx, AppName,
         Items)

   For n = 1 to Items

     '******************************
     ' Get next Application/Database 
     ' item from the list
     '******************************
     sts = EsbGetNextItem (hCtx,
           ESB_CAPPDB_TYPE, AppDb)
   Next
End Sub

See Also

EsbGetDatabaseInfo()
EsbGetDatabaseState()
EsbListApplications()
EsbListDatabases()
EsbListObjects()
EsbGetNextItem()