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

ixIndexWord

NAME

 ixIndexWord

SYNOPSIS

void IndexWord(OnixIndexingEngineT IndexingEngine, WordTypeT *Word, StatusCodeT *Status);

ARGUMENTS

 IndexingEngine -- Indexing engine which you obtained via the call to ixStartIndexingSession().

 *Word  -- Pointer to the Word structure which contains the word you want to index.  The Word field in the Word structure contains the word you want to index.  IMPORTANT NOTE: The word in Word (Word.Word) must be stored as a simple string.  It does not need to be 0 terminated (Though it doesn't hurt.)  The Length field in Word must be filled in with the length of the word.  The other fields in Word can be ignored.

 *Status  -- Pointer to the value Status which is used to report error and status conditions.

RETURNS

 Nothing.
 If an error occurs, Status will be set to an error value.

DESCRIPTION

ixIndexWord() is as with ixIncrementRecord() one of the core routines used for indexing the text.  With ixIndexWord(), you are telling the indexing engine the words you want to index for the current record. The word you want to index is passed in through the Word field of the word structure.  The Length field in the Word structure must then be set to the length of the word in bytes.  While there are several other fields in the Word structure, in the current version of Onix, you do not need to fill them in.  If an error occurs, Status will be filled in with an error value.

SEE ALSO

 ixStartIndexingSession, ixEndIndexingSession, ixIncrementRecord, ixIndexWordEx, ixMakeIndexActive, ixFinalProcessIndex