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

ixFindRecordID

Name

ixFindRecordID

Synopsis

void ixFindRecordID(OnixIndexManagerT IndexManager, UCharT *RecordIDName, RecordNumT *RecordNum, StatusCodeT *Status)

Arguments

IndexManager: An index manager returned by a callto ixCreateIndexManager() which has an index opened and a retrieval session in progress (started by ixStartRetrievalSession).

RecordIDName: A pointer to a string which specifies the record ID. The record Id needs to be in a hexadecimal format similar to the format used to process queries. The only difference is that it may not contain any query operators within the record ID. (For example, if your record ID is cat-123, the '-' would be encoded as a hexadecimal character and NOT as the character itself.) This means that you need to use ixCharToHex to do the conversion and not ixConvertQuery since '-' is a reserved operator in the Onix query language.

RecordNum: A pointer to an integer of type RecordNumT. The record number of the most recent record with the Id specified by RecordIDName will be placed here.

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

Given an index which has the RecordIDs stored with every record and a record number, ixFindRecordID will return the record number of the most recent record with a given record ID.As you might expect, you should have a retrieval session in progress before attempting to retrieve the record number of a record with a specific record ID. The record number is returned into the integer pointed to by RecordNum. If two or more records have the same record ID, the most recent (the one with the highest record number) will be returned.

See Also

Record IDs
ixProcessRecordID, ixRetrieveRecordID