Cloud data provider types: Oracle Analytics Cloud - Essbase
On-premises data provider types: Oracle Essbase
Description
HypQueryMembers() executes the member selection query.
Syntax
HypQueryMembers (vtSheetName, vtMemberName, vtPredicate, vtOption, vtDimensionName, vtInput1, vtInput2, vtMemberArray)
ByVal vtSheetName As Variant
ByVal vtMemberName As Variant
ByVal vtPredicate As Variant
ByVal vtOption As Variant
ByVal vtDimensionName As Variant
ByVal vtInput1 As Variant
ByVal vtInput2 As Variant
ByRef vtMemberArray 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.
vtMemberName: The member for which to retrieve information. Required; there is no default value.
vtPredicate: Member selection criteria (integer):
1 = HYP_CHILDREN
2 = HYP_DESCENDANTS
3 = HYP_BOTTOMLEVEL
4 = HYP_SIBLINGS
5 = HYP_SAMELEVEL
6 = HYP_SAMEGENERATION
7 = HYP_PARENT
8 = HYP_DIMENSION
9 = HYP_NAMEDGENERATION
10 HYP_NAMEDLEVEL
11 HYP_SEARCH
12 HYP_WILDSEARCH
13 HYP_USERATTRIBUTE
14 HYP_ANCESTORS
15 HYP_DTSMEMBER
16 HYP_DIMUSERATTRIBUTES
vtOption: (integer) Options are dependent on the predicate. For the predicate values, HYP_SEARCH and HYP_WILDSEARCH, specify query options:
HYP_MEMBERSONLY
HYP_ALIASESONLY
HYP_MEMBERSANDALIASES
vtDimensionName: (string) Dimension to limit the scope of the query. It is used with the following query options and ignored otherwise: HYP_NAMEDGENERATION, HYP_NAMEDLEVEL, HYP_USERATTRIBUTE, HYP_SEARCH (set to Null to search through all dimensions), HYP_WILDSEARCH (set to Null to search through all dimensions).
vtInput1: (string) Input string that is determined by the option. It is used with the following query options and ignored otherwise:
HYP_NAMEDGENERATION (The name of the generation)
HYP_NAMEDLEVEL (The name of the level)
HYP_SEARCH (The string to search for. The string is defined as an exact)
HYP_WILDSEARCH (The string to search for. The string is defined as an exact search string with an optional '*' at the end to mean any set of characters)
HYP_USERATTRIBUTE (The user-defined attribute)
vtInput2: (string) Input string that is determined by the option. It is used with the following query options and ignored otherwise:
HYP_USERATTRIBUTE (The user-defined attribute)
HYP_SEARCH, HYP_WILDSEARCH (If the options are set to search in the alias tables, this string specifies which alias table to search. If the string is Null, all alias tables will be searched).
vtMemberArray: Output that contains the result of the query. If unsuccessful, its contents are unknown.
Return Value
Returns a zero if successful; otherwise, returns the appropriate error code.
Example
Declare Function HypQueryMembers Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtMemberName As Variant, ByVal vtPredicate As Variant, ByVal vtOption As Variant, ByVal vtDimensionName As Variant, ByVal vtInput1 As Variant, ByVal vtInput2 As Variant, ByRef vtMemberArray As Variant) As Long
Sub Example_HypQueryMembers()
' sts = HypQueryMembers(Empty, "Profit", HYP_CHILDREN, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Profit", HYP_DESCENDANTS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Profit", HYP_BOTTOMLEVEL, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SIBLINGS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SAMELEVEL, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_SAMEGENERATION, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_PARENT, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_DIMENSION, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Year", HYP_NAMEDGENERATION, Empty, "Year", "Quarter", Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_NAMEDLEVEL, Empty, "Product", "SKU", Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_SEARCH, HYP_ALIASESONLY, "Product", "Cola", Empty, vArray)
' sts = HypQueryMembers(Empty, "Year", HYP_WILDSEARCH, HYP_MEMBERSONLY, "Year", "J*", Empty, vArray)
' sts = HypQueryMembers(Empty, "Market", HYP_USERATTRIBUTE, Empty, "Market", "Major Market", Empty, vArray)
' sts = HypQueryMembers(Empty, "Sales", HYP_ANCESTORS, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Jan", HYP_DTSMEMBER, Empty, Empty, Empty, Empty, vArray)
' sts = HypQueryMembers(Empty, "Product", HYP_DIMUSERATTRIBUTES, Empty, Empty, Empty, Empty, vArray)
If IsArray(vt) Then
cbItems = UBound(vt) + 1
MsgBox ("Number of elements = " + Str(cbItems))
For i = 0 To UBound(vt)
MsgBox ("Member = " + vt(i))
Next
Else
MsgBox ("Return Value = " + Str(vt))
End If
End Sub