EssOtlGetDimensionUserAttributes

指定された次元で使用されるユーザー定義属性を戻します。

構文

            ESS_FUNC_M 
            EssOtlGetDimensionUserAttributes
             (
            hOutline
            , 
            pPredicate
            , 
                                             
            pCounts
            , 
            ppAttributeNames
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	Essbaseアウトライン・ハンドル。これはEssOtlOpenOutlineQuery()から戻されている必要があります。
pPredicate	ESS_PREDICATE_T	クエリーを定義している構造体。この構造体のフィールドの用法: ulQuery - 実行する操作を定義する値。有効な唯一の値はESS_DIMUSERATTRIBUTESです。 pszDimension- クエリー範囲を制限する次元。有効な次元名を指定します。
pCounts	ESS_MBRCOUNTS_T	カウントに関する情報を定義している構造体。次のフィールドが含まれます: ulStart- 戻す最初の番号 ulMaxCount- 戻されるメンバー名の最大数 ulTotalCount- クエリーの実行結果において定義されるメンバーの合計数 pulReturnCount- このクエリーで戻されたメンバー名の数
ppAttributeNames	ESS_PPMBRNAME_T	このクエリーから戻される属性名の配列。

備考

この関数は、特定の次元でユーザーが定義した属性を取得するために使用します。したがって、Predicateに有効な唯一の値はESS_DIMUSERATTRIBUTES_Tです。
メンバーまたは次元の解決順プロパティは、計算順序を指定します。
メンバーの解決順は次元の解決順よりも優先されます。解決順は0から127までにできます。デフォルトは0です。
解決順が指定されていない式を持たないメンバーは、その次元の解決順を継承します。解決順が指定されていない式を持つメンバーは、ゼロの解決順を持ちます。

戻り値

関数が正常終了した場合、戻り値は0になります。

例

         #include <essapi.h>
#include <essotl.h>

ESS_STS_T          sts = ESS_STS_NOERR; 
ESS_HOUTLINE_T     hOutline; 
ESS_OBJDEF_T       Object;
ESS_PREDICATE_T    Predicate;
ESS_MBRCOUNTS_T    Counts;   
ESS_MBRNAME_T      pAttribNames;
ESS_ULONG_T        i;
ESS_ACCESS_T       Access;
ESS_STR_T          AppName;
ESS_STR_T          DbName;

AppName = "Sample";
DbName = "Basic";

sts = EssSetActive(hCtx, AppName, DbName, &Access);

if ( sts == 0)
{
   memset(&Object, '\0', sizeof(Object));    

   sts = EssOtlOpenOutlineQuery(hCtx, &Object, &hOutline); 

   memset(&Predicate, '\0', sizeof(Predicate));  
   Predicate.ulQuery       = ESS_DIMUSERATTRIBUTES;
   Predicate.pszDimension  = "Market";

   memset(&Counts, '\0', sizeof(Counts));  
   Counts.ulStart    = 0;
   Counts.ulMaxCount = 10;

   if(!sts)
   {
     sts = EssOtlGetDimensionUserAttributes(hOutline, 
             &Predicate, &Counts, &pAttribNames);

     if (!sts && Counts.ulReturnCount)
     {
        sts = EssFree(hInstance, pAttribNames);
     }
   }
}