Onix Text Retrieval Toolkit
API Reference

API
Function List
Topical List

Main Index

Introduction
Calling Sequences
Query Processing
Relevancy Ranking
Data Types
Error Handling
   
Support
   
Lextek Products
Onix Text Retrieval Engine
Lextek Document Profiler & Categorizer
Brevity Document Summarizer
RouteX Routing Engine
Language Identifier

ixHighlightMatcherMatch

Name

ixHighlightMatcherMatch

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

Highlighting
ixCreateHighlightMatcher, ixDeleteHighlightMatcher, ixAddWildCardPatternToHighlightMatcher