EssLRODeleteCellObjects

Essbaseデータベースの指定されたデータ・セルにリンクされているすべてのオブジェクトを削除します。セルにリンクされている特定のオブジェクトを削除するには、EssLRODeleteObjectを使用します。

構文

            ESS_FUNC_M EssLRODeleteCellObjects (
            hCtx, memCount, pMemComb, pulLROCount, pLRODescList
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	APIコンテキスト・ハンドル。
memCount	ESS_ULONG_T	pMemCombで指定されたメンバーの数。
pMemComb	ESS_PVOID_T	メンバー名の配列。
pulLROCount	ESS_ULONG_T	削除されたLROカタログ・エントリ数。
pLRODescList	ESS_LRODESC_API_T	削除されたLROカタログ・エントリのリスト。

備考

この関数では、指定されたセルにリンクされているすべてのオブジェクトがそれらのカタログ・エントリと一緒に削除されます。
オブジェクトがサーバーに保管されていない場合は、セル・リンクのみ破棄され、ファイルは削除されません。
呼出し元は、pLRODescListに割り当てられたメモリーの解放に責任を持ちます。

戻り値

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

アクセス

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

例

         ESS_FUNC_M ESS_LRO DeleteCellObjects (ESS_HCTX_T hCtx, ESS_HINST_T hInst)
{
        ESS_LRODESC_API_T               plroDescList=NULL;
        ESS_PMBRNAME_NONUNI_T   pMemComb = NULL;
        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 = EssLRODeleteCellObjects(hCtx, memCount, pMemComb, &ulLroCount, &plroDescList);
        if (sts)
        {
                printf ("Could not delete cell objects. \n");
        }
        EssFree( hInst, pMemComb);
        if (plroDescList)
                EssFree(hInst, plroDescList);
        return sts;
}