EsbLRODeleteObject

Description

EsbLRODeleteObject() deletes a specific object linked to a data cell in an Essbase database. To delete all objects linked to a cell, use EsbLRODeleteCellObjects().

Syntax

EsbLRODeleteObject (hCtx, pLinkId)

ByVal hCtx    As Long
      pLinkId As ESB_LROHANDLE_API_T

Parameters

hCtx Essbase API context handle.
pLinkId Pointer to object identification structure. The structure is returned by EsbLROAddObject() through the ESB_LRODESC_API_T structure.

Return Value

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

Notes

Access

A call to this function requires write privileges (ESB_PRIV_WRITE) to the data cell or the active database.

Example

Declare Function EsbLRODeleteObject Lib "esbapin" _
(ByVal hCtx As Long, pLinkID As ESB_LROHANDLE_API_T) _
As Long

Public Sub ESB_LRODeleteObject()

   Dim LinkID As ESB_LROHANDLE_API_T
   
   LinkID.hObject = 1
   LinkID.cellKey.cellOffset = 0
   LinkID.cellKey.blkOffset = 198
   LinkID.cellKey.segment = 0
   
   sts = EsbLRODeleteObject(hCtx, LinkID)

End Sub

See Also

LRO Constant and Structure Definitions
EsbLROAddObject()
EsbLRODeleteCellObjects()
EsbLROPurgeObjects()