EssOtlQueryGenerationInfo

EssOtlQueryGenerationInfo()は、次元の最上位メンバーのコメント・フィールドに含まれている時間次元生成情報のクエリーを行います。この情報を一度取得すると、EssOtlGetLinkedAttributeAttachLevel() とともに使用して前期比の分析を実行できます。

構文

            ESS_FUNC_M 
            EssOtlQueryGenerationInfo
             (
            hOutline, szName, queryID, ppReturns
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトライン・ハンドル。これはEssOtlOpenOutlineQuery()から戻されている必要があります。
szName	ESS_STS_T	日時次元の最上位メンバーの名前
queryID	ESS_ULONG_T	クエリー識別子定数ESS_OTLQRYTIDIM_TIMEPERIODSを使用します
ppReturns	ESS_PPVOID_T	この次元のクエリー情報構造体へのポインタ。

備考

EssOtlQueryGenerationInfo()の呼出し元は、構造体IDがESS_DT_STRUCT_TIGENINFOのEssOtlFreeStructure()を呼び出し、戻される構造体ポインタ用に用意されているメモリーを解放します。

戻り値

正常に終了した場合は、ESS_PTIMEDIM_GENINFO_T構造体へのポインタが戻されます。

例

SS_STR_T strBuf1 = "Year"; ESS_ULONG_T queryId = ESS_OTLQRYTIDIM_TIMEPERIODS; ESS_PVOID_T pReturns; ESS_PTIMEDIM_GENINFO_T tpStruc = NULL; sts = EssOtlQueryGenerationInfo (hOutline, /*query outline handle*/ strBuf1, /* IN - date-time dimension member name*/ queryId, /* IN - query ID */ &pReturns); if (sts) goto exit; switch (queryId) { case ESS_OTLQRYTIDIM_TIMEPERIODS: tpStruc = (ESS_PTIMEDIM_GENINFO_T)pReturns; for (ii = 0; ii < tpStruc->usCount; ii++) fprintf(cmdctxp->output, "Time period for Gen %d = %s\n", ii+1, TimePeriodNames[tpStruc->ptps[ii]]); sts = EssOtlFreeStructure (cmdctxp->hOutline[hOutlineChoice], ESS_DT_STRUCT_TIGENINFO, 1, pReturns); if (sts) goto exit; break; default: break; }