EssLRODeleteCellObjects

Deletes all objects linked to a given data cell in an Essbase database. To delete a specific object linked to a cell, use EssLRODeleteObject.

Syntax

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

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
memCount	ESS_ULONG_T	Number of members specified in pMemComb.
pMemComb	ESS_PVOID_T	Array of member names.
pulLROCount	ESS_ULONG_T	Number of LRO catalog entries deleted.
pLRODescList	ESS_LRODESC_API_T	List of LRO catalog entries deleted.

Notes

This function deletes all objects linked to the specified cell along with their catalog entries.
If the object is not stored on the server, only the cell link is destroyed; the file is not deleted.
The caller is responsible for freeing memory allocated for pLRODescList.

Return Value

If successful, returns ESS_STS_NOERR. Otherwise, returns an error code.

Access

A call to this function requires write privileges (ESS_PRIV_WRITE) to the active database.

Example

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;
}