EssLROGetCatalog

Essbaseデータベース内の指定したデータ・セルについて、LROカタログ・エントリのリストを取得します。

構文

            ESS_FUNC_M EssLROGetCatalog (
            hCtx, memCount, pMemComb, pulLROCount, ppLRODescList)

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
memCount	ESS_ULONG_T	pMemCombで指定されたメンバーの数。
pMemComb	ESS_PMBRNAMECOMB_T	メンバー名の配列。
pulLROCount	ESS_ULONG_T *	呼出し元に戻されるLROカタログ・エントリの数。
pLRODescList	ESS_LRODESC_API_T	呼出し元に戻されるLROカタログ・エントリのリストへのポインタのアドレス。

戻り値

正常終了の場合は、ESS_STS_NOERRが戻されます。それ以外の場合、エラー・コードが戻されます。

アクセス

この関数を呼び出すには、アクティブなデータベースに対して読取り権限(ESS_PRIV_READ)を持っている必要があります。

例

         ESS_FUNC_M ESS_LRO GetCatalog (ESS_HCTX_T hCtx, ESS_HINST_T hInst)
{
        ESS_PMBRNAME_NONUNI_T   pMemComb = NULL;
        ESS_PLRODESC_API_T              plroDescList=NULL;
        ESS_USHORT_T            usOption = 0;
        ESS_ULONG_T             memCount;
        ESS_FUNC_M              sts = ESS_STS_NOERR;
        ESS_ULONG_T             ulLroCount;
        memCount = 5;
        sts = EssAlloc(hInst, memCount*sizeof(ESS_MBRNAME_NONUNI_T),
                       (ESS_PPVOID_T)&pMemComb);
        if(sts)
        {
                printf("Could not allocate memory \n");
                return sts;
        }
        memset(pMemComb, 0, memCount*sizeof(ESS_MBRNAME_NONUNI_T));
        strcpy( pMemComb[0], "Profit");
        strcpy( pMemComb[1], "East");
        strcpy( pMemComb[2], "Actual");
        strcpy( pMemComb[3], "Colas");
        strcpy( pMemComb[4], "Year");
        sts = EssLROGetCatalog(hCtx, memCount, pMemComb, &ulLroCount, &plroDescList);
        if (sts)
        {
                printf ("Could not get the catalog \n");
        }
        EssFree(hInst, pMemComb);
        if(plroDescList)
        {
                EssFree(hInst, pMemComb);
        }
        return sts;
}