HypGetDimensions
Cloud data provider types: Oracle Analytics Cloud - Essbase, Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting
On-premises data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Hyperion Financial Management
Description
HypGetDimensions() returns an array containing the dimension names in the grid and an array containing their corresponding types. HypGetDimensions() can be used in place of the deprecated HypGetPOV() function.
Type array has five possible types (row, column, page, POV, user variable), which can be identified using the following enumeration:
Enum DIMENSION_TYPE
ROW_DIM = 0
COL = 1
POV = 2
PAGE = 3
USERVAR = 5
End Enum
To uniquely identify the user variable, use the user variable name rather than the dimension name.
Syntax
HypGetDimensions (vtSheetName, vtMemberNames, vtType)
ByVal vtSheetName As Variant
ByRef vtMemberNames As Variant
ByRef vtType As Variant
Parameters
vtSheetName: Input parameter; the name of worksheet on which to run the function. If vtSheetName is Null
or Empty
, the active worksheet is used.
vtMemberNames: Output variable; the dimension name array present in the grid
vtType: Output variable; the type information for the respective dimension
Return Value
Returns 0 if successful; otherwise, returns the appropriate error code.
Example
This example assumes that the worksheet is connected and has a grid.
Public Declare Function HypGetDimensions Lib "HsAddin" (ByVal vtSheetName As Variant, ByRef vtMemberNames As Variant, ByRef vtType As Variant) As Long
Sub Example_GetDimensions()
sts = HypGetDimensions("Sheet1", vtDim, vtType)
End Sub