Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY CUSTOMIZATION, Manual

Page: 139 / 612

Handling Extensible Match Filters
Chapter 11 Writing Matching Rule Plug-Ins 139
Writing a Filter Index Function
The filter index function takes a single
Slapi_PBlock
argument. This function will
never be called for the same filter object concurrently. (If you plan to manipulate
global variables, keep in mind that the server can call this function concurrently for
different filter objects.)
The filter index function should do the following:
1.
Get the filter object from the
SLAPI_PLUGIN_OBJECT
parameter (if the
parameter is set).
2.
Using data from the object, determine and set the values of the following
parameters:
❍
Set the
SLAPI_PLUGIN_MR_OID
parameter to the official OID of the
matching rule.
SLAPI_PLUGIN_PRIVATE void *
(Input parameter) Pointer to any
private data originally specified in
the initialization function. (See
“Writing an Initialization
Function” on page 143 for details.)
SLAPI_PLUGIN_MR_FILTER_MATCH_FN mrFilterMatchFn
(function pointer)
(Output parameter) Name of the
function called by the server to
match an entry’s attribute values
against the value in the extensible
search filter.
SLAPI_PLUGIN_MR_FILTER_INDEX_FN void *
(function pointer)
(Output parameter) Name of the
function called by the server to
generate a list of keys used for
indexing a set of values.
SLAPI_PLUGIN_DESTROY_FN void *
(function pointer)
(Output parameter) Name of the
function to be called to free the
filter object.
SLAPI_PLUGIN_OBJECT void *
(Output parameter) Pointer to the
filter object created by your factory
function.
Table 11-4 Input and Output Parameters Available to a Filter Factory Function (Continued)
Parameter Name Data Type Description