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

ixFindKey

Name

ixFindKey

Synopsis

void ixFindKey(OnixIndexManagerT IndexManager, DictionaryCursorT *Cursor, UCharT *Word, BooleanT *Found, ULongT *NumRecords, ULongT *NumWords, StatusCodeT *Status)

Arguments

IndexManager: An index manager which has an open index associated with it.

Cursor: A dictionary cursor of type DictionaryCursorT.  This keeps track of where you are in the indexes wordlist.

Word: The word to be found should be passed in here represented as a Pascal string.  (A Pascal string is a string where the first character gives its length.)

Found: Pointer to a value of type BooleanT.  If the word specified in Word is found, Found will be set to BooleanTrue otherwise it will be set to BooleanFalse.

NumRecords: Pointer to a value of type unsigned long.  If the word was found, NumRecords will be set to the number of records in which the word occurs.

NumWords: Pointer to a value of type unsigned long.  If the word Word was found, NumWords will be set to the total number of times the word occurs.

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

xFindKey is used to locate a specific word in the index.  It sets the dictionary cursor Cursor to point to the word and fill in the number of times the word occurs into the variables NumRecords and NumWords.

To locate a specific word in the index, the index manager must be associated with an open index (via the ixOpenIndex() function) and a retrieval session must have been started using the function ixStartRetrievalSession().  The word must be passed in via the pointer Word which points to a Pascal string.  (A Pascal string is a string of characters where the first character gives the length of the string.  For example, the word printer would look like 7printer -- where the "7" is the character 0x07).

ixFindKey will overwrite any information which is in the dictionary cursor.  (If your application needs to keep track of more than one place in the word list, it is all right to use more than one dictionary cursor.)  If the word was found, the BooleanT variable Found will be set to BooleanTrue or BooleanFalse if the word was not found.  Furthermore, if the word Word was found, NumRecords and NumWords will be filled in with the number of records the word occurs in and the total number of times the word occurs throughout all the records.

See Also

Word Lists
ixCurrentKey, ixNextKey, ixPreviousKey