HypSetMembers
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
HypSetMembers() sets the list of POV dimension choices in ad hoc grids and the Page list in Financial Management forms.
This function cannot be used to set the Page list in Planning forms, nor can it be used to set row or column members.
The member list submitted by the user is validated before it is set.
Syntax
HypSetMembers (vtSheetName, vtDimensionName, ParamArray MemberList())
ByVal vtSheetName As Variant
ByVal vtDimensionName As Variant
ParamArray MemberList() 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 set
MemberList: Input variable; the array of member names to be set as choices
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. Note: "InvalidMember" does not belong to the Entity dimension and therefore will not be included in the list of dimension choices.
Public Declare Function HypSetMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtDimensionName As Variant, ParamArray MemberList() As Variant) As Long
Sub Example_HypSetMembers()
sts = HypSetMembers("Sheet1", "Entity", "Regional", "InvalidMember", "None")
End Sub