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

ixAddStopWord

NAME

ixAddStopWord -- Adds a stopword to the stopword list.

SYNOPSIS

void ixAddStopWord(OnixStopWordListT StopWordList, UCharT *Word, size_t WordLength, StatusCodeT *Status);

ARGUMENTS

StopWordList -- A stop word list which was created by a call to ixCreateStopWordList().

Word  -- A pointer to the word's data.

WordLength -- The length of the word in bytes.

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

RETURNS

Nothing.

DESCRIPTION

ixAddStopWord adds a stopword to the stopword list. The stopword list is created by a call to ixCreateStopWordList and destroyed by a call to ixDeleteStopWordList. To add a word to the stopword list, call ixAddStopWord with a pointer to the word (Word) and the length (WordLength) of the word in bytes.

Typically, stopwords are words such as "and", "the", "of", "it", etc. These words do not hold much "informational" content in a text and for this reason are not often searched upon. (And typically when a user does search for these words, more search results are returned than is needed.)

SEE ALSO

ixCreateStopWordList, ixDeleteStopWordList, ixAddStopWord, ixAddStopWordList, ixIsStopWord, ixNumStopWords