EsbLROAddObject

Description

EsbLROAddObject() links reporting objects to a data cell in an Essbase database.

Syntax

EsbLROAddObject  (hCtx, memCount, MemComb, usOption, pLRODesc)

ByVal hCtx     As Long
ByVal memCount As Long
ByVal MemComb  As String
ByVal usOption As Integer
      pLRODesc As ESB_LRODESC_API_T

Parameters

hCtx Essbase API context handle.
MemCount The number of members specified in pMemComb.
MemComb String of member names (EOL, CR delimited) that define the data cell to be linked.
usOption Option specifying where to store the object. Use one of the following:
ESB_STORE_OBJECT_API stores an object on the server.
ESB_NOSTORE_OBJECT_API to not store on server.
pLRODesc Pointer to object's description structure, ESB_LRODESC_API_T.

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 EsbLROAddObject Lib "esbapin" _
(ByVal hCtx As Long, ByVal memCount As Long, _ 
ByVal memComb As String, ByVal usOption As Integer, _
pLRODesc As ESB_LRODESC_API_T) As Long

Public Sub ESB_LROAddObject()

   Dim Desc As ESB_LRODESC_API_T
   Dim memCount As Long
   Dim memComb As String
   Dim opt As Integer
   Dim i As Integer
   
   Desc.userName = "Admin"
   
   Desc.ObjType = ESB_LROTYPE_CELLNOTE_API
   Desc.note = "Note from DFS"
   

   memCount = 5
   memComb = "Jan" & vbCrLf & "Sales" & _
             "Cola" & vbCrLf & "Utah" & _
             "Actual"

   opt = ESB_NOSTORE_OBJECT_API
            
   sts = EsbLROAddObject(hCtx, memCount, memComb, _
                         opt, Desc)   
End Sub

See Also

LRO Constant and Structure Definitions
EsbLROGetObject()
EsbLROUpdateObject()
EsbLRODeleteObject()