EsbLROGetCatalog() retrieves a list of linked object catalog entries for a given data cell in an Essbase database.
EsbLROGetCatalog (hCtx, memCount, memComb, PulCount) ByVal hCtx As Long ByVal memCount As Long ByVal memComb As String PulCount As Integer
hCtx | Essbase API context handle. |
memCount | Number of members specified in memComb . |
memComb | Array of member names. |
PulCount | Number of LRO catalog entries returned to caller. |
If successful, returns ESB_STS_NOERR. Otherwise, returns an error code.
To retrieve the catalog information, call EsbGetNextItem() after calling this function. The example code demonstrates how to do this.
A call to this function requires read privileges (ESB_PRIV_READ) for the data cell or the active database.
Declare Function EsbLROGetCatalog Lib "esbapin" _ (ByVal hCtx As Long, ByVal memCount As Long, _ ByVal memComb As String, PulCount As Integer) As Long Public Sub ESB_LROGetCatalog() Dim Desc As ESB_LRODESC_API_T Dim Items As Integer Dim memCount As Long Dim memComb As String Dim i As Integer memCount = 5 memComb = "Jan" & vbCrLf & "Sales" & _ "Cola" & vbCrLf & "Utah" & _ "Actual" sts = EsbLROGetCatalog(hCtx, memCount, _ memComb, Items) If sts = 0 Then For i = 1 To Items '******************************* '* Get the next LRO description '* item from the list '******************************* sts = EsbGetNextItem(hCtx, ESB_LRO_TYPE, Desc) Next i End If End Sub
LRO Constant and Structure Definitions
EsbGetNextItem()
EsbLROAddObject()
EsbLROUpdateObject()
EsbLROGetObject()
EsbLRODeleteObject()