Netscape Directory Server Programmer's Guide: Function Reference

Complete Contents
Getting Started
Chapter 1 Understanding Server Plug-Ins
Chapter 2 Writing and Compiling Plug-Ins
Chapter 3 Calling the Front-End API Functions
Chapter 4 Quick Start
Chapter 5 Writing Database Plug-Ins
Chapter 6 Writing Pre/Post-Operation Plug-Ins
Chapter 7 Defining Functions for LDAP Operations
Chapter 8 Defining Functions for Database Operations
Chapter 9 Defining Functions for Authentication
Chapter 10 Writing Entry Store/Fetch Plug-Ins
Chapter 11 Writing Extended Operation Plug-Ins
Chapter 12 Writing Matching Rule Plug-Ins
Chapter 13 Data Type and Structure Reference
Chapter 14 Function Reference
Chapter 15 Parameter Reference
Glossary

Contents

Bookshelf

Function List

slapi_send_ldap_result()

Sends an LDAP result code back to the client.

Syntax

#include "slapi-plugin.h"
void slapi_send_ldap_result( Slapi_PBlock *pb, int err,
char *matched, char *text, int nentries,
struct berval **urls );

Parameters

The function has the following parameters:
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. (Pass NULL in other situations.)

text
Error message that you want sent back to the client. (Pass 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. (Pass NULL in other situations.)

Description

Call slapi_send_ldap_result() to send an LDAP result code (such as LDAP_SUCCESS) back to the client.

The following arguments are intended for use only in certain situations:

matched

When sending an LDAP_NO_SUCH_OBJECT result code back to a client, use matched to specify how much of the target DN could be found in the database. For example, if the client was attempting to find the DN:

cn=Babs Jensen, ou=Product Division, o=Ace Industries, c=US

and the database contains entries for "c=US" and "o=Ace Industries, c=US", but no entry for "ou=Product Division, o=Ace Industries, c=US", you should set the matched parameter to:

o=Ace Industries, c=US

urls

When sending an LDAP_PARTIAL_RESULTS result code back to an LDAP v2 client or an LDAP_REFERRAL result code back to an LDAP v3 client, use urls to specify the referral URLs.

For LDAP v3 referrals, you can call the slapi_send_ldap_referral() to send referrals to LDAP v3 clients and collect them for LDAP v2 clients. You can pass the array of collected referrals to the urls argument of slapi_send_ldap_results(). For example:

struct berval **urls;

...

slapi_send_ldap_referral( ld, e, &refs, &urls );

slapi_send_ldap_result( ld, LDAP_PARTIAL_RESULTS, NULL, NULL, 0,
urls );

If you want to define your own function for sending result codes, write a function complies with the type definition send_ldap_result_fn_ptr_t and set the SLAPI_PLUGIN_DB_RESULT_FN parameter in the parameter block to the name of your function.

Example

[To be added]