HypQueryMembers

データ・プロバイダ・タイプ: 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: メンバー選択条件(整数):

vtOption: predicateに依存するオプション(整数):predicateの値がHYP_SEARCHおよびHYP_WILDSEARCHの場合は、次のクエリー・オプションを指定します:

vtDimensionName: クエリーの範囲を制限する次元(文字列)。このフィールドは、次のクエリー・オプションで使用され、それ以外では無視されます: HYP_NAMEDGENERATION、HYP_NAMEDLEVEL、HYP_USERATTRIBUTE、HYP_SEARCH(Nullに設定するとすべての次元が検索されます)、HYP_WILDSEARCH(Nullに設定するとすべての次元が検索されます)。

vtInput1: オプションによって決まる入力文字列(文字列)。このフィールドは、次のクエリー・オプションで使用され、それ以外では無視されます:

vtInput2: オプションによって決まる入力文字列(文字列)。このフィールドは、次のクエリー・オプションで使用され、それ以外では無視されます:

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", 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