# EsbGetCurrencyRateInfo

Description

EsbGetCurrencyRateInfo() gets a list of structures containing rate information for all members of the tagged currency partition dimension in the active database outline.

Syntax

    EsbGetCurrencyRateInfo (hCtx, pItems)

    ByVal hCtx   As Long
          pItems As Integer

Parameters

hCtx | Essbase VB API context handle.
pItems | Address of variable to receive the Items of rate info structures.

Return Value

If successful, this function returns a Items of structures in pItems and generates an array of Currency info structures accessible via EsbGetNextItem().

Notes

- This function can be called for regular databases with associated currency databases.

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

    Sub ESB_GetCurrencyRateInfo ()
       Dim Items As Integer
       Dim RateInfo As ESB_RATEINFO_T
       Dim sts As Long

       '************************
       ' Get Currency Rates Info
       '************************
       sts = EsbGetCurrencyRateInfo (hCtx, Items)

       For n = 1 To Items
         '*************************
         ' Get next Rates Info item
         'from the list
         '*************************
         sts = EsbGetNextItem (hCtx,
         ESB_RATEINFO_TYPE, RateInfo)
       Next
    End Sub

See Also

EsbListCurrencyDatabases()
EsbGetNextItem()
EsbSetActive