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

Indexing Based on Matching Rules
6.
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.
Table 11-1 Input and Output Parameters Available to an Indexer Factory Function
Parameter Name
SLAPI_PLUGIN_MR_OID
SLAPI_PLUGIN_MR_TYPE
SLAPI_PLUGIN_MR_USAGE
142 Netscape Directory Server Plug-in Programmer's Guide • October 2004
Set the
SLAPI_PLUGIN_DESTROY_FN
responsible for freeing any memory allocated by the factory function,
such as the indexer object. See "Writing a Destructor Function," on
page 153, for details.
Return (or the result code
0
successfully.
Data Type
char *
char *
unsigned int
parameter to the function
) 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 152.