EssLRODeleteObject

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

Syntax

ESS_FUNC_M EssLRODeleteObject (hCtx, plinkId);

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	API context handle.
plinkId	ESS_LROHANDLE_API_T	Pointer to object identification structure.

Notes

The specified object is deleted and also removed from the Catalog list.
If the object is not stored on the server, only the cell link is destroyed; the file is not deleted.

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 DeleteObject (ESS_HCTX_T hCtx)
{
        ESS_FUNC_M              sts = ESS_STS_NOERR;
        ESS_LROHANDLE_API_T     linkId;
        memset(&linkId, 0, sizeof(ESS_LROHANDLE_API_T));
        linkId.hObject = 26;
        linkId.cellKey.cellOffset = 282;
        linkId.cellKey.blkOffset = 113;
        linkId.cellKey.segment = 0;
        sts = EssLRODeleteObject(hCtx, &linkId);
        if (sts)
        {
                printf("Could not delete object\n");
        }
        return sts;
}