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

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 NULL 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: A pointer to a value of type StatusCodeT representing any error conditions.

Returns

Nothing.

If an error occurred, Status will be set to the error number.

Description

ixIndexWord along with ixIncrementRecord are 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

Indexing
ixStartIndexingSession, ixEndIndexingSession, ixIncrementRecord, ixIndexWordSpecial, ixIndexNumber, ixMakeIndexActive, ixFinalProcessIndex