Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 184 / 612

Summary of Data Types and Structures
184 Netscape Directory Server Plug-In Programmer’s Guide • December 2003
send_ldap_result_fn_ptr_t
send_ldap_result_fn_ptr_t
specifies the prototype for a callback function that
you can write to send LDAP result codes back to the client. You can register your
function so that it is called whenever the
slapi_send_ldap_result()
function is
called.
Syntax
#include “slapi-plugin.h”
typedef void (*send_ldap_result_fn_ptr_t)( Slapi_PBlock *pb,
int err, char *matched, char *text, int nentries,
struct berval **urls );
Parameters
The function has the following parameters:
Description
The
slapi_send_ldap_result()
function is responsible for sending LDAP result
codes back to the client. You can replace the function that sends LDAP result codes
to the client with your own function. To do this:
1.
Write a function with the prototype specified by
send_ldap_result_fn_ptr_t
.
pb
Parameter block.
err
LDAP result code that you want sent back to the client (for example,
LDAP_SUCCESS
).
matched
When sending back an
LDAP_NO_SUCH_OBJECT
result code, use this
argument to specify the portion of the target DN that could be
matched.
text
Error message that you want sent back to the client. Use NULL if you
do not want an error message sent back.
nentries
When sending back the result code for an LDAP search operation, use
this argument to specify the number of matching entries found.
urls
When sending back an
LDAP_PARTIAL_RESULTS
result code to an
LDAP v2 client or an
LDAP_REFERRAL
result code to an LDAP v3
client, use this argument to specify the array of
berval
structures
containing the referral URLs.