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
Previous Next Contents Bookshelf Datatypes List



 send_ldap_referral_fn_ptr_t
send_ldap_referral_fn_ptr_t specifies the prototype for a callback function that you can write to send LDAP v3 referrals (search result references) back to the client. You can register your function so that it is called whenever the slapi_send_ldap_referral() function is called.

Syntax

#include "slapi-plugin.h"
typedef int (*send_ldap_referral_fn_ptr_t)( Slapi_PBlock *pb,
Slapi_Entry *e, struct berval **refs, struct berval ***urls);

Parameters

The function has the following parameters:
pb

Parameter block.
e

Pointer to the Slapi_Entry structure representing the entry that you are working with.
refs

Pointer to the NULL-terminated array of berval structures containing the LDAP v3 referrals (search result references) found in the entry.
urls

Pointer to the array of berval structures used to collect LDAP referrals for LDAP v2 clients.

Returns. 0 if successful, or -1 if an error occurs.

Description. The slapi_send_ldap_referral() function is responsible for sending LDAP v3 referrals (search result references) back to the client. You can replace the function that sends LDAP v3 referrals 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.
  2. In your plug-in initialization function, register your function by setting the SLAPI_PLUGIN_DB_REFERRAL_FN parameter in the parameter block to the name of your function.
See "slapi_send_ldap_referral()" on page  339 for information on the default function that sends LDAP v3 referrals to clients.

Example

[To be added]

See Also

slapi_send_ldap_referral().

 

© Copyright 1998 Netscape Communications Corporation