The Start_Browse_Results Call - IBM SC34-6814-04 Customization Manual

LDAP_RESPONSE(name4)
LDAP_SESSION_TOKEN(name4)
SEARCH_TIME_LIMIT(name4)
SEARCH_TOKEN(name4)
RESPONSE and REASON values for SEARCH_LDAP:
RESPONSE
OK
EXCEPTION
DISASTER
INVALID
KERNERROR
PURGED
Note: For more detail, refer to the explanation of RESPONSE and REASON in

The START_BROWSE_RESULTS call

The START_BROWSE_RESULTS call allows you to browse the results (attributes
or entries) returned by the SEARCH_LDAP call. START_BROWSE_RESULTS
starts the browse at the first or only entry returned (there may be multiple entries
returned by the search). The GET_NEXT_ENTRY call allows you to retrieve other
entries.
START_BROWSE_RESULTS can be issued more than once for a
SEARCH_TOKEN. If the call is issued after a GET_NEXT_ENTRY or
GET_NEXT_ATTRIBUTE call, the browse position will be reset to the start of the
search results.
START_BROWSE_RESULTS
address of the data, and the second word contains the length in bytes of the
data. For more information on block-descriptors, see "XPI syntax" on page 319.
specifies the return code that is sent by the LDAP API.
the name of the fullword token that was returned by the BIND_LDAP function.
specifies the time limit for the search (in seconds). If the search is not
successful within this time limit, the search is abandoned. If this parameter is
not specified or is zero, the search time is unlimited.
the name of the fullword token that identifies and holds the current position in
the search.
"Making an XPI call" on page 308.
DFHDDAPX [CALL],
[CLEAR],
[IN,
FUNCTION(START_BROWSE_RESULTS),
SEARCH_TOKEN(name4),
[DISTINGUISHED_NAME(buffer-descriptor),]]
[OUT,
REASON
None
INVALID_BUFFER_LENGTH
INVALID_TOKEN
NOTFOUND
TIMED_OUT
LDAP_INACTIVE
None
None
None
None
Chapter 3. The user exit programming interface (XPI)
329