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

Function Calls By Group

Create and dispose of the index manager

ixCreateIndexManager
ixDeleteIndexManager

Creating indexes

ixCreateIndexCreationParams
ixDeleteIndexCreationParams
ixSetIndexCreationParams
ixResetIndexCreationParams
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
ixIndexNumber
ixIncrementRecord
ixStemEnglishWord
ixFinalProcessIndex
ixMakeIndexActive
ixAbortIndexingSession
ixForceCloseOfTemporaryFiles

Additional Routines for performing distributed indexing

ixStartDistributedIndexingSession
ixEndDistributedIndexingSession
ixAppendDistributedDataToIndex

Additional Routines for setting distributed indexes

ixSetBaseDistributedIndexDirectory
ixSetFinalIndexDataFileNameAndPosition

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 help give statistics about the index

ixNumberOfRecordsInIndex
ixHighestRecordNumberInIndex
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
ixSetNormalizedHits

Routines for accessing and navigating the wordlist

ixFindKey
ixNextKey
ixPreviousKey
ixCurrentKey

Routines for manually processing queries

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

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 for managing and getting status information

ixGetStatusMessage
ixGetLibraryCompileDateAndTime

See Also

Functions by Name