Netscape DIRECTORY SERVER 6.1 - PLUG-IN Manual page 382

Functions for Handling Matching Rules
Parameters
This function takes the following parameters:
pb
Returns
This function returns the result code returned by the indexer factory function.
Description
This function calls the indexer factory function for the plug-in responsible for
handing a specified matching rule. The matching rule is identified by the OID in
the
SLAPI_PLUGIN_MR_OID
If no plug-ins are associated with this matching rule, the function calls the indexer
factory function for each matching rule plug-in until the
SLAPI_PLUGIN_MR_INDEX_FN
Before calling this function, make sure that the parameter block
information needed by the indexer factory function. You can pass information to
the indexer factory function by using the following parameters:
•
SLAPI_PLUGIN_MR_OID
want used for indexing or sorting.
•
SLAPI_PLUGIN_MR_TYPE
for indexing or sorting.
•
SLAPI_PLUGIN_MR_USAGE
indexing (
(
The indexer factory function should set the following parameters:
•
SLAPI_PLUGIN_MR_OID
that you want used for indexing or sorting.
•
SLAPI_PLUGIN_MR_INDEX_FN
responsible for indexing or sorting, based on the matching rule OID or
attribute type.
•
SLAPI_PLUGIN_OBJECT
to the indexer function.
382 Netscape Directory Server Plug-In Programmer's Guide • August 2002
Parameter block containing information about the matching rule
and attribute type to be used in indexing or sorting.
SLAPI_PLUGIN_MR_USAGE_INDEX
SLAPI_PLUGIN_MR_USAGE_SORT
parameter.
parameter is set to an indexer function.
should contain the OID of the matching rule that you
should contain the attribute type that you want used
should specify if the indexer will be used for
) or for sorting
).
should contain the official OID of the matching rule
should specify the name of the indexer function
should contain any information that you want passed
contains the
pb