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
DFHDDAPX [CALL],
[CLEAR],
[IN,
FUNCTION(START_BROWSE_RESULTS),
SEARCH_TOKEN(name4),
[DISTINGUISHED_NAME(buffer-descriptor),]]
[OUT,
[LDAP_RESPONSE(name4),]
[ATTRIBUTE_COUNT(name4),]
RESPONSE(name1 | *),
REASON(name1 | *)]
This command is threadsafe.
- DISTINGUISHED_NAME(buffer-descriptor)
- indicates the buffer where you want the
distinguished name of the first, or only located result returned.
A group of three fullwords are specified for the buffer-descriptor:
- The address where the data is returned.
- The length of the buffer in bytes, where the data is returned.
- The maximum length in bytes of the data. This can be specified as *, and the length is then returned in DDAP_DISTINGUISHED_NAME_N.
- ATTRIBUTE_COUNT(name4)
- a fullword indicating the number of attributes that can be browsed in the current entry.
- LDAP_RESPONSE(name4)
- specifies the return code that is sent by the LDAP API.
- SEARCH_TOKEN(name4)
- the name of the fullword token that is returned by the SEARCH_LDAP function.
RESPONSE and REASON values for START_BROWSE_RESULTS
| RESPONSE | REASON |
|---|---|
| OK | None |
| EXCEPTION | INVALID_TOKEN |
| INVALID_BUFFER_LENGTH | |
| INVALID_CALLING_SEQUENCE | |
| DISASTER | None |
| INVALID | None |
| KERNERROR | None |
| PURGED | None |
Note: For more detail, refer to the explanation of RESPONSE
and REASON in Making an XPI call.