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

ixHighlightMatcherMatch

NAME

ixHighlightMatcherMatch -- Match a term against a series of wildcard patterns.

SYNOPSIS

BooleanT ixHighlightMatcherMatch(HighlightMatcherT HighlightMatcher, UCharT *Word, size_t WordLength)

ARGUMENTS

HighlightMatcher -- A Highlight Matcher created with a call to ixCreateHighlightMatcher() with some wildcard patterns stored in it.

Word -- A pointer to the word to be matched.  (This word may contain binary data and must not contain any length indicators.)

WordLength -- The length of the word Word.

RETURNS

BooleanTrue or BooleanFalse depending on whether the word matches the stored wildcard patterns.

DESCRIPTION

ixHighlightMatcherMatch matches the word Word with the stored wildcard patterns in the HighlightMatcher.  If the word matches, then ixHighlightMatcherMatch returns BooleanTrue otherwise ixHighlightMatcherMatch returns BooleanFalse.  After you are done matching all the words that need to be matched, be sure to dispose of the matcher using ixDeleteHighlightMatcher().

SEE ALSO

ixCreateHighlightMatcher, ixDeleteHighlightMatcher, ixAddWildCardPatternToHighlightMatcher