EsbGetDimensionInfo

Description

EsbGetDimensionInfo() gets dimension information.

Syntax
EsbGetDimensionInfo (hCtx, Dimension, pItems)

ByVal hCtx      As Long
ByVal Dimension As String
      pItems    As Integer

Parameters

hCtxEssbase API context handle.
DimensionMember name of dimension for which to return information. If NULL, returns information about each dimension.
pItemsNumber of information structures returned.

Return Value

If successful, returns a reference to the number of dimension information structures.

Notes

Access

This function requires the caller to have database design privilege for the specified database (ESB_PRIV_DBDESIGN).

Example

Declare Function EsbGetDimensionInfo Lib "ESBAPIW" (ByVal hCtx As Long, ByVal Dimension As String, pItems As Integer) As Long Sub ESB_GetDimensionInfo() 
   Dim sts As Long
   Dim Dimension As String
   Dim nDims As Integer
   Dim DimInfo As ESB_DIMENSIONINFO_T

   Dimension = "Year"
   sts = EsbGetDimensionInfo(hCtx, Dimension, nDims)

   If Not sts Then
     For n = 1 To nDims
     '**************************
     ' Get next Dimension Info
     ' from the list
     '**************************
     sts = EsbGetNextItem(hCtx,
      ESB_DIMINFO_TYPE, DimInfo)
    Next
   End If
End Sub

See Also

EsbBuildDimension()
EsbGetApplicationInfo()
EsbGetApplicationInfoEx()
EsbGetDatabaseInfo()