Iterating Through Candidates - Netscape DIRECTORY SERVER 6.02 - PLUG-IN Manual

Processing an LDAP Search Operation
Parameter ID
SLAPI_SEARCH_FILTER
SLAPI_SEARCH_STRFILTER
SLAPI_SEARCH_ATTRS
SLAPI_SEARCH_ATTRSONLY
Your search function should return 0 if successful. Call the
function to assign the set of search results to the
parameter in the parameter block.
The front-end then uses this function in conjunction with the "next entry" function
(see "Iterating Through Candidates" on page 82) to iterate through the result set.
The front-end sends each result back to the client and continues updates the
SLAPI_NENTRIES
client.
If a result is actually a referral, the front-end sends the referral back to the client
and updates the
URLs.
Finally, after sending the last entry to the client, the front-end sends an LDAP
result message specifying the number of entries found.

Iterating Through Candidates

In addition to the parameters specified in "Processing an LDAP Search Operation"
on page 80, the "next entry" function has access to the following parameters (which
are set by the front-end and the back-end during the course of executing a search
operation):
82 Netscape Directory Server Plug-In Programmer's Guide • May 2002
Data Type
Slapi_Filter *
char *
char **
int
parameter with the current number of entries sent back to the
SLAPI_SEARCH_REFERRALS
Description
Slapi_Filter struct (an
opaque data structure)
representing the filter to be used
in the search.
String representation of the filter
to be used in the search.
Array of attribute types to be
returned in the search results.
Specifies whether the search
results return attribute types only
or attribute types and values. (0
means return both attributes and
values; 1 means return attribute
types only)
slapi_pblock_set()
SLAPI_SEARCH_RESULT_SET
parameter with the list of referral