EsbGetDimensionInfo

Gets dimension information.

Syntax

EsbGetDimensionInfo (hCtx, Dimension, pItems)
ByVal hCtx      As Long
ByVal Dimension As String
      pItems    As Integer

Parameter	Description
hCtx	API context handle.
Dimension	Member name of dimension for which to return information. If NULL, returns information about each dimension.
pItems	Number of information structures returned.

Notes

The caller must call EsbGetNextItem with the ESB_DIMINFO_TYPE parameter.
Attributes:
- The constant values ESB_TTYPE_ATTRIBUTE and ESB_TTYPE_ATTRCALC for theDimTag field of the ESB_DIMENSIONINFO_T structure indicate that the dimension is an attribute dimension.
- TheDimDataType field of the ESB_DIMENSIONINFO_T structure indicates the type of attribute dimension.

Return Value

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

Access

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

Example

Declare Function EsbGetDimensionInfo Lib "ESBAPIN" (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