EsbLROListObjects

Retrieves a list of all objects linked to cells in the active database for a given user name and/or modification date.

Syntax

EsbLROListObjects (hCtx, userName, listDate, PulCount)
ByVal hCtx     As Long 
ByVal userName As String 
ByVal listDate As Long 
ByVal PulCount As Integer

Parameter	Description
hCtx	API context handle.
userName	A user name. If specified, returns a list of all objects last modified by the given user.
listDate	A modification date. If specified, returns a list of all objects modified on or before the given date. The time is a Long representing the number of seconds since January 1, 1970.
PulCount	Number of LRO catalog entries returned.

Notes

If you specify both the userName and listDate parameters, objects meeting both criteria are listed.
To retrieve the list of objects, call EsbGetNextItem after calling this function. The example code demonstrates how to do this.
In order to replicate the functionality of EssLROListObjects() using EsbLROListObjects(), you must call EsbLROGetMemberCombo after calling EsbGetNextItem.

Return Value

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

Access

A call to this function requires read privileges (ESB_PRIV_READ) to the date cell or the active database.

Example

Declare Function EsbLROListObjects Lib "esbapin" _
(ByVal hCtx As Long, ByVal userName As String, _
ByVal listDate As Long, PulCount As Integer) As Long

Public Sub ESB_LROListObjects()
      
   Dim userName As String * ESB_USERNAMELEN
   Dim listDate As Long
   Dim Items As Integer
   Dim Desc As ESB_LRODESC_API_T
   Dim i As Integer
   Dim CutOffDate As Date
   
   Const ESB_REFERENCE_DATE = #1/1/70#
   userName = "admin"
   CutOffDate = #8/1/97#          
   listDate = DateDiff("s", CutOffDate, _
                      ESB_REFERENCE_DATE)
   
   sts = EsbLROListObjects(hCtx, userName, _
                           listDate, 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