The Main Manual Page Dynamic API Documentation CD-ROM API Documentation About Onix Types About Onix Errors Onix's Web Site at Lextek International Lextek International Onix Full Text Indexing and Retrieval Toolkit

ixAddWildCardPatternToHighlightMatcher

NAME

ixAddWildCardPatternToHighlightMatcher -- Add a wildcard pattern to the pattern matcher.

SYNOPSIS

void ixAddWildCardPatternToHighlightMatcher(HighlightMatcherT HighlightMatcher, UCharT *Pattern, size_t PatternLength, StatusCodeT *Status);

ARGUMENTS

HighlightMatcher -- A HighlightMatcher which was created by a call to ixCreateHighlightMatcher().

Pattern  -- A pointer to a wildcard pattern.

PatternLength  -- The length of the wildcard pattern.

Status -- A pointer to a value of type StatusCodeT.  If an error occurs, it will be reported in *Status.

RETURNS

Nothing.

DESCRIPTION

ixAddWildCardPatternToHighlightMatcher adds a wildcard pattern to the wildcard pattern matcher.  The matcher can handle either "?" (to represent a single character) or "*" (to represent multiple characters.)  If you need to have either one of these characters in the word itself, you can use the forward slash symbol to escape these characters.  (Such as "\?", "\*", or "\\".)  This pattern matcher can handle binary data because of this you need to provide the length of the pattern in PatternLength.  There is no practical limit to the number of patterns the highlight matcher will match.  (Though there could be some performance limitations at some point depending on the application.)

SEE ALSO

ixCreateHighlightMatcher, ixDeleteHighlightMatcher, ixHighlightMatcherMatch