14.8. plugin_search_entry_callback

This typedef is used for LDAP search entry callback functions, which are plug-in defined functions that process LDAP entries that are located by an internal search.
Syntax

This typedef uses the following syntax:

#include "slapi-plugin.h"
typedef int (*plugin_search_entry_callback)(Slapi_Entry *e, void *callback_data);
Parameters

This typedef takes the following parameters:

Table 14.11. plugin_search_entry_callback Parameters

e Pointer to the Slapi_Entry structure representing an entry found by the search.
callback_data This value matches the callback_data pointer that was passed to the original internal operation function.
Returns

The following table lists this function's possible return values.

Table 14.12. plugin_search_entry_callback Return Values

Return Value Description
0 Success
-1 An error occurred.
Description

A function that matches this typedef can be passed as the psec parameter of slapi_search_internal_callback_pb() or as the srch_callback parameter of slapi_seq_internal_callback_pb().

The LDAP referral entry callback function will be called once for each referral entry found by a search operation, which means it could be called zero or any number of times.
The callback_data parameter can be used to pass arbitrary plug-in or operation-specific information to a referral entry callback function.