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

ixIsStopWord

Name

ixIsStopWord

Synopsis

BooleanT ixIsStopWord( OnixStopWordListT StopWordList, size_t PrefixLength, UCharT *Word, size_t WordLength)

Arguments

StopWordList: A stop word list which was created by a call to ixCreateStopWordList.

PrefixLength: The length of any characters before the actual word (specified by Word) which should be ignored in the lookup.

Word: A pointer to the word's data.

WordLength: The length of the word in bytes.

Returns

BooleanTrue if the word is in the stopword list, BooleanFalse otherwise.

Description

ixIsStopWord checks to see if the word Word is in the stopword list. During the lookup the number of characters specified by PrefixLength is ignored from the beginning of the word. The lookup is case sensitive and so for a word to match, it must match exactly (minus the prefix characters specified by PrefixLength) as it was entered into the stopword list (either by ixAddStopWord or ixAddStopWordList.)

If a match is found, ixIsStopWord returns BooleanTrue and if a match is not found, it returns BooleanFalse.

See Also

Dealing with Stop Words, Stop Word List 1, Stop Word List 2
ixCreateStopWordList, ixDeleteStopWordList, ixAddStopWord, ixAddStopWordList, ixIsStopWord, ixNumStopWords