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

Onix Function Calls By Group


Create and dispose of the index manager

ixCreateIndexManager()
ixDeleteIndexManager()

Creating indexes

ixCreateIndexCreationParams()
ixDeleteIndexCreationParams()
ixSetIndexCreationParams()
ixCreateIndex()
ixCreateIndexEx()

Get and set the location of temporary files and get their sizes

ixSetLocationForTemporaryFiles()
ixGetLocationForTemporaryFiles()
ixGetTempDiskSpaceUsage()

Opening and closing indexes

ixOpenIndex()
ixCloseIndex()
ixReloadIndex()

Routines for indexing

ixStartIndexingSession()
ixEndIndexingSession()
ixIndexWord()
ixIndexWordSpecial()
ixIncrementRecord()
ixStemEnglishWord()
ixFinalProcessIndex()
ixMakeIndexActive()
ixSetFinalIndexDataPosition()

Additional Routines for performing distributed indexing

ixStartDistributedIndexingSession()
ixEndDistributedIndexingSession()
ixAppendDistributedDataToIndex()

 

Routines for storing and retrieving an arbitrary piece of data that is associated with every record

ixStoreRecordData()
ixStoreMoreRecordData()
ixRetrieveRecordData()
ixRetrieveMoreRecordData()

Functions for managing record IDs

ixProcessRecordID()
ixRetrieveRecordID()
ixFindRecordID()

Functions to manage the partitions in a multifile index


ixChangePartitionLocation()
ixWritePartitionLocation()

Functions to help give statistics about the index

ixNumberOfRecordsInIndex()
ixGetNumberOfUnoptomizedInsertions()

Routines for managing the deletions of records

ixIsRecordDeleted()
ixDeleteRecordNum()
ixDeleteRecordNums()
ixUnDeleteRecordNum()
ixUnDeleteRecordNums()
ixOutputDeletedRecords()
ixGetNumberOfRecordsDeleted()

Routines for the processing of standard queries

ixStartRetrievalSession()
ixEndRetrievalSession()
ixConvertQuery()
ixConvertQuery2()
ixLongQueryFormToShortQueryForm()
ixCharToHex()
ixHexToChar()
ixCharWordToHexWord()
ixProcessQuery()
ixNumHits()

Routines for accessing and navigating the wordlist

ixFindKey()
ixNextKey()
ixPreviousKey()
ixCurrentKey()

Routines for manually processing queries

ixCreateResultVector()
ixDeleteResultVector()
ixGetCurrentQueryVector()
ixVectorAnd()
ixVectorOr()
ixVectorNot()
ixVectorRewind()
ixVectorCurrentHit()
ixVectorNextHit();
ixVectorNextRecord()
ixVectorPreviousHit()
ixVectorPreviousRecord()
ixVectorAddHit()

Unicode support routines

ucInitializeNormalizationTable()
ucTableNormalizeChar()
ucNormalizeChar()
ixUnicodeCharToHex()
ixUnicodeHexToChar()

Routines to assist in highlighting query terms

ixCreateHighlightMatcher()
ixDeleteHighlightMatcher()
ixAddWildCardPatternToHighlightMatcher()
ixHighlightMatcherMatch()

Routines to assist web crawlers parse robots.txt

ixCreateRobotsTxtParser()
ixDeleteRobotsTxtParser()
ixSetRobotName()
ixParseRobotsTxt()
ixOutputCompactRobotsTxt()
ixRobotsPermissionGranted()
ixRobotsPermissionGrantedFullURL()
ixRobotsTxtLength()

Routines for managing the stop word list

ixCreateStopWordList()
ixDeleteStopWordList()
ixAddStopWord()
ixAddStopWordList()
ixIsStopWord()
ixNumStopWords()

Routines to manage the optimization of the index

ixPerformOptimization()
ixOptimizeIndex()
ixEndOptimization()
ixIndexNeedsLittleOptimization()
ixIndexNeedsBigOptimization()

 

Used to get the current status message text string (Errors, UnErrors, etc.)

ixGetStatusMessage()