Onix Text Retrieval Toolkit
API Reference

Function List
Topical List

Main Index

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





void IndexWordSpecial(OnixIndexingEngineT IndexingEngine, WordTypeT *Word, ULongT Flags, ULongT Param, StatusCodeT *Status)


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.

Flags: Flags that determine how the word is to be indexed. Currently the bit flag IX_SAME_AS_LAST_ENTRY is supported. If Flags are set to 0 (zero), then ixIndexWordSpecial acts the same as ixIndexWord.

Param: This is currently not used. Set it to 0 (zero) when using.

Status: A pointer to a value of type StatusCodeT representing any error conditions.



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


ixIndexWordSpecial functions similarly to ixIndexWord. Its use is to have a extra control as to how a word is indexed. Its primary use at this point in time is with the flag IX_SAME_AS_LAST_ENTRY which indexes the word at the same location (or word offset) as the last word indexed. This allows you to have one or more words at a given word offset in your index.

ixIndexWord as with ixIndexWordSpecial and ixIncrementRecord are the core routines used for indexing the text.  With ixIndexWord and ixIndexWordSpecial, 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, ixIndexWordSpecial, ixMakeIndexActive, ixFinalProcessIndex, ixIndexWord