Syntax

#include "slapi-plugin.h"
int slapi_search_internal_callback( char *ibase, int scope,
char *ifstr, char **attrs, int attrsonly,
void *callback_data, LDAPControl **controls,
plugin_result_callback prc,
plugin_search_entry_callback psec,
plugin_referral_entry_callback prec);

Parameters

The function has the following parameters:

ibase	Distinguished name (DN) of the entry that serves as the starting point for the search. For example, setting base to "o=Ace Industry, c=US" restricts the search to entries at Ace Industry in the United States.
scope	Scope of the search, which can be one of the following values: LDAP_SCOPE_BASE searches the entry specified by base. LDAP_SCOPE_ONELEVEL searches all entries one level beneath the entry specified by base. LDAP_SCOPE_SUBTREE searches the entry specified by base and all entries at all levels beneath the entry specified by base.
ifstr	String representation of the filter to apply in the search.
attrs	A NULL-terminated array of attribute types to return from entries that match filter. If you specify a NULL, all attributes will be returned.
attrsonly	Specifies whether or not attribute values are returned along with the attribute types. This parameter can have the following values: 0 specifies that both attribute types and attribute values are returned. 1 specifies that only attribute types are returned.
callback_data	A pointer to data that you want passed to the callback functions specified by the prc, psec, and prec arguments.
controls	A NULL-terminated array of LDAP controls (see "LDAPControl" on page  193) that you want applied to the search operation.
prc	Callback function that the server calls to send result codes. The function must have the prototype specified by plugin_result_callback.
psec	Callback function that the server calls when finding a matching entry in the directory. The function must have the prototype specified by plugin_search_entry_callback.
prec	Callback function that the server calls when finding an entry that contains LDAP v3 referrals. The function must have the prototype specified by plugin_referral_entry_callback.

Returns. A new parameter block (see "Slapi_PBlock" on page  215) with the following parameters set:

• SLAPI_PLUGIN_INTOP_RESULT specifies the LDAP result code for the internal LDAP operation (for example, LDAP_SUCCESS if the operation is successful or LDAP_PARAM_ERROR if an invalid parameter is used).
• SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES specifies an array of entries (pointers to Slapi_Entry structures) found by the search.
• SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS specifies an array of referrals (strings) found by the search. Referrals are in the form of LDAP URLs.

Description. Like the slapi_search_internal() function, the slapi_search_internal_callback() function allows you to search the directory from a plug-in function.

Unlike a search operation requested by a client, no result code, search entries, or referrals are sent to a client by slapi_search_internal_callback(). However, you can write your own callback functions that are invoked when these events occur:

• You can write a callback function that is invoked when the search operation normally sends a result code to the client.

This function must have the prototype specified by plugin_result_callback. You specify this function in the prc argument of slapi_search_internal_callback().

• You can write a callback function that is invoked when the search operation normally sends a search entry to the client.

This function must have the prototype specified by plugin_search_entry_callback. You specify this function in the psec argument of slapi_search_internal_callback().

• You can write a callback function that is invoked when the search operation normally sends LDAP v3 referrals (search result references, which are normally sent to the client as results found by the search) to an LDAP v3 client.

Note he function is not called for LDAP v2 clients, since version 2 of the LDAP protocol does not support the mechanism for sending search result references to clients. (In the LDAP v2 protocol, the server just sends an LDAP_PARTIAL_RESULT result code back to the client.)

This function must have the prototype specified by plugin_referral_entry_callback. You specify this function in the prec argument of slapi_search_internal_callback().

The rest of the arguments for this function are similar to the arguments for the slapi_search_internal() function.

Example

[To be added]

See Also