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

ixFindRecordID

 

NAME

ixFindRecordID()

SYNOPSIS

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

ARGUMENTS

IndexManager -- An index manager returned by a call to 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 -- Pointer to a value of type StatusCodeT

RETURNS

Nothing.

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

ixProcessRecordID, ixRetrieveRecordID