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

slapi_search_internal()

Performs an LDAP search operation to search the directory from your plug-in.

#include "slapi-plugin.h"
Slapi_PBlock *slapi_search_internal( char *base, int scope,
char *filter, LDAPControl **controls, char **attrs,
int attrsonly );

The function has the following parameters:
base
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.

filter
String representation of the filter to apply in the search.

controls
A NULL-terminated array of LDAP controls (see "LDAPControl" on page 193) that you want applied to the search operation.

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.

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.

When you are done working with the search results, you should free the results in the parameter block by calling the slapi_free_search_results_internal() function.

Description. This function allows you to search the directory from a plug-in function. The arguments for this function are similar to the arguments for the standard ldap_search() function in the Netscape LDAP C SDK.

Unlike the standard LDAP search operation, no data is sent to a client:

The internal search operation does not send an LDAP result code to a client.

When the internal search operation finds a matching entry, no entry is sent to a client.

If the internal search operation finds an entry that contains LDAP v3 referrals, no referrals are sent to a client.

Although these tasks are not performed during an internal search operation, you can write your own callback functions that are invoked when these events occur. For details, see "slapi_search_internal_callback()" on page 336.

© Copyright 1998 Netscape Communications Corporation