HypGetMembers
Describes the Oracle Smart View for Office VBA function, HypGetMembers.
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
HypGetMembers() gets the list of selected or used members for a given dimension present in the grid.
For Essbase, Oracle Analytics Cloud - Essbase, Oracle Hyperion Planning, and Planning , member names are based on the selected alias table.
For Financial Management, the second array returns the descriptions.
For POV (in forms), Page (in ad hoc) and user variables, a single member is returned.
To uniquely identify the user variable, provide the user variable name rather than the dimension name.
Syntax
HypGetMembers (vtSheetName, vtDimensionName, vtMbrNameChoices, vtMbrDescChoices)
ByVal vtSheetName As Variant
ByVal vtDimensionName As Variant
ByRef vtMbrNameChoices As Variant
ByRef vtMbrDescChoices As Variant
Parameters
vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null
or Empty
, the active worksheet is used.
vtDimensionName: Input variable; the name of the dimension for which the selected member list is to be returned
vtMbrNameChoices: Output variable; the array of member names used
vtMbrDescChoices: Output variable; the array of member name descriptions. For Essbase, Oracle Analytics Cloud - Essbase, Oracle Hyperion Planning, and Planning , this is the same as member names. This list will be empty if the dimension is a row or column 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 HypGetMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ByRef vtMbrNameChoices As Variant, ByRef vtMbrDescChoices As Variant) As Long
Sub Example_HypGetMembers()
sts = HypGetMembers("Sheet1", "Year", vtMbr, vtDes)
End Sub