HypQueryMembers

Cloudデータ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase

説明

HypQueryMembers()は、メンバー選択問合せを実行します。

構文

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

パラメータ

vtSheetName: 関数を実行するワークシートの名前。vtSheetNameがNullまたはEmptyの場合、アクティブなワークシートが使用されます。

vtMemberName: 情報を取得するメンバー。必須。デフォルト値はありません。

vtPredicate: メンバー選択条件(整数):

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: (整数)オプションは述部に依存します。述部の値がHYP_SEARCHおよびHYP_WILDSEARCHの場合は、次の問合せオプションを指定します。

HYP_MEMBERSONLY
HYP_ALIASESONLY
HYP_MEMBERSANDALIASES

vtDimensionName: (文字列)問合せの範囲を制限するディメンション。これは、問合せオプションHYP_NAMEDGENERATION、HYP_NAMEDLEVEL、HYP_USERATTRIBUTE、HYP_SEARCH (Nullに設定するとすべてのディメンションが検索されます)、HYP_WILDSEARCH (Nullに設定するとすべてのディメンションが検索されます)で使用され、それ以外では無視されます。

vtInput1: (文字列)オプションによって決まる入力文字列。これは、次の問合せオプションで使用され、それ以外では無視されます。

HYP_NAMEDGENERATION (世代の名前)
HYP_NAMEDLEVEL (レベルの名前)
HYP_SEARCH (検索する文字列。この文字列は完全一致として定義されています)
HYP_WILDSEARCH (検索する文字列。この文字列は、末尾にオプションの'*'が付いた完全一致検索文字列として定義されており、'*'部分は任意の文字の組合せが可能です)
HYP_USERATTRIBUTE (ユーザー定義属性)

vtInput2: (文字列)オプションによって決まる入力文字列。これは、次の問合せオプションで使用され、それ以外では無視されます。

HYP_USERATTRIBUTE (ユーザー定義属性)
HYP_SEARCH、HYP_WILDSEARCH (オプションの設定で別名表を検索するようになっている場合、この文字列では検索する別名表を指定します。文字列がNullの場合、すべての別名表が検索されます)。

vtMemberArray: 問合せの結果を格納する出力。正常に終了しなかった場合、コンテンツは不明になります。

戻り値

正常に終了した場合はゼロ(0)を戻し、それ以外の場合は該当するエラー・コードを戻します。

例

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