Netscape DIRECTORY SERVER 6.02 - PLUG-IN Manual page 430

Functions for Sending Entries and Results to the Client
Returns
This function returns one of the following values:
• 0 if successful.
• -1 if an error occurs.
Description
When you call this function, the server processes the LDAP referrals specified in
the
refs
on the version of the LDAP protocol supported by the client:
• In the LDAP v3 protocol, references to other LDAP servers (search result
references) can be sent to clients as search results. (For example, a server can
send a mixture of entries found by the search and references to other LDAP
servers as the results of a search.)
When you call the
clients, the server sends the referrals specified in the
the client as search result references. (The
case.)
• In the LDAP v2 protocol, servers can send the LDAP result code
LDAP_PARTIAL_RESULTS
When you call the
clients, the server collects the referrals specified in
argument. No data is sent to the LDAP v2 client.
To get the referrals to an LDAP v2 client, you need to pass the
(along with an
slapi_send_ldap_result()
concatenates the referrals specified in the
resulting string to the client as part of the error message.
If you want to define your own function for sending referrals, write a function
complies with the type definition
SLAPI_PLUGIN_DB_REFERRAL_FN
your function.
See Also
slapi_send_ldap_result()
slapi_send_ldap_search_entry()
430 Netscape Directory Server Plug-In Programmer's Guide • May 2002
argument. The server processes referrals in different ways, depending
slapi_send_ldap_referral()
to refer the client to other LDAP server.
slapi_send_ldap_referral()
LDAP_PARTIAL_RESULTS
argument is not used in this
urls
result code) to the
function.
slapi_send_ldap_result()
argument and sends the
urls
send_ldap_referral_fn_ptr_t
parameter in the parameter block to the name of
function for LDAP v3
argument back to
refs
function for LDAP v2
in the
refs urls
argument
urls
and set the