Netscape DIRECTORY SERVER 6.1 - PLUG-IN Manual page 349

Table 15-13 Filter Routines (Continued)
Function
slapi_find_matching_paren()
slapi_str2filter()
slapi_vattr_filter_test()
slapi_filter_apply()
Applies a function to each simple filter component within a complex filter; a simple
filter is anything other than AND, OR, or NOT.
Syntax
#include "slapi-plugin.h"
int slapi_filter_apply( struct slapi_filter *f, FILTER_APPLY_FN fn,
void *arg, int *error_code );
Parameters
This function takes the following parameters:
f
fn
arg
error_code
Returns
This function returns an integer. Possible return values for
include:
•
SLAPI_FILTER_SCAN_NOMORE
Description
Finds the matching right parentheses in a string (corresponding to the
left parenthesis to which the string currently points)
Converts a string description of a search filter into a filter of the
Slapi_Filter type.
Tests a filter against a single entry.
Filter on which the function is to be applied.
Function to apply.
Argument to the function (fn).
Pointer to error code of
calling function. Possible values
may set in
error_code
SLAPI_FILTER_UNKNOWN_FILTER_TYPE
FILTER_APPLY_FN
only.
(Indicates success in traversing the entire filter)
Functions for Dealing with Filters
, which can be accessed by
fn
slapi_filter_apply()
include
. Note that a
should return
_STOP
slapi_filter_apply()
Chapter 15
or
_CONTINUE
Function Reference 349