Getting And Setting Parameters In Indexer Factory Functions - Netscape DIRECTORY SERVER 6.02 - PLUG-IN Manual

Table of Contents

Advertisement

Indexing Based on Matching Rules
Return 0 (or the result code
6.
successfully.
Getting and Setting Parameters in Indexer
Factory Functions
The following table summarizes the different parameters that the indexer factory
function should get and set in the parameter block that is passed in:
Input and Output Parameters Available to a Indexer Factory Function
Table 11-1
Parameter Name
SLAPI_PLUGIN_MR_OID
SLAPI_PLUGIN_MR_TYPE
SLAPI_PLUGIN_MR_USAGE
132
Netscape Directory Server Plug-In Programmer's Guide • May 2002
Set the
SLAPI_PLUGIN_DESTROY_FN
for freeing any memory allocated by the factory function, such as the
indexer object. (See "Writing a Destructor Function" on page 143 for
details.)
Data Type
char *
char *
unsigned int
parameter to the function responsible
) if everything completed
LDAP_SUCCESS
Description
(Input parameter) Matching rule OID (if
any) specified in the index directive.
(Input parameter) Attribute type (if any)
specified in the index directive.
(Input parameter) Specifies the intended
use of the indexer object. This parameter
can have one of the following values:
• SLAPI_PLUGIN_MR_USAGE_INDEX
specifies that the indexer object should
be used to index entries.
• SLAPI_PLUGIN_MR_USAGE_SORT
specifies that the indexer object should
be used to sort entries.
You can use this to specify different
information in the indexer object or
different indexer functions, based on
whether the plug-in is used for indexing or
sorting.
For information on sorting search results,
see "Handling Sorting by Matching Rules"
on page 142.

Advertisement

Table of Contents
loading

This manual is also suitable for:

Directory server 6.02

Table of Contents