Getting And Setting Parameters In Filter Index Functions - Netscape DIRECTORY SERVER 7.0 - PLUG-IN Manual

Handling Extensible Match Filters
Return
3.
successfully.
Getting and Setting Parameters in Filter Index
Functions
The following table summarizes the different parameters that the filter index
function should get and set in the parameter block that is passed in.
Table 11-5 Input and Output Parameters Available to a Filter Index Function
Parameter Name
SLAPI_PLUGIN_OBJECT
SLAPI_PLUGIN_MR_QUERY_OPERATOR
150 Netscape Directory Server Plug-in Programmer's Guide • October 2004
Set the
SLAPI_PLUGIN_MR_TYPE
filter object.
Set the
SLAPI_PLUGIN_MR_VALUES
object.
Set the
SLAPI_PLUGIN_MR_QUERY_OPERATOR
operator that corresponds to this search filter. See "Query Operators in
Matching Rules," on page 146, for possible values for this parameter.
Set the
SLAPI_PLUGIN_OBJECT
Set the
SLAPI_PLUGIN_MR_INDEX_FN
See "Writing the Indexer Function," on page 143.
(or the result code
0
Data Type
void *
int
parameter to the attribute type in the
parameter to the values in the filter
parameter to the filter object.
parameter to the indexer function.
) if everything completed
LDAP_SUCCESS
Description
Input and Output parameter. Pointer
to the filter object created by the
factory function. For details, see
"Writing a Filter Factory
Function," on page 147.
Output parameter. Query operator
used by the server to determine
how to compare the keys
generated from
SLAPI_PLUGIN_MR_VALUES and
SLAPI_PLUGIN_MR_INDEX_FN
against keys in the index.
For a list of possible values for this
parameter, see "Query Operators
in Matching Rules," on page 146.
parameter to the query