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

ixRetrieveRecordID

 

NAME

ixRetrieveRecordID()

SYNOPSIS

void ixRetrieveRecordID(OnixIndexManagerT IndexManager, UCharT *Buff, size_t BuffSize, size_t *ReturnedIDSize, UCharT *HexRecordID, RecordNumT RecordNum, StatusCodeT *Status);

ARGUMENTS

IndexingEngine -- An indexing engine which was returned by a call to ixStartIndexingSession()

*Buff -- A pointer to a string which is large enough to contain the RecordID. (For future compatibility reasons, this should be a buffer 256 bytes in length or greater.)

BuffSize -- The size of the buffer in bytes.

*ReturnedIDSize -- The length of the returned RecordID in bytes.

HexRecordID -- A buffer into which a hexadecimal representation of the RecordID may be placed. This can be set to NULL if you do not need a hexadecimal copy of the RecordID. This buffer should be 2 times the length of the longest possible RecordID plus three bytes in length or safely 515 bytes.

RecordNum -- The number of the record for which you would like the RecordID.

*Status -- Pointer to a value of type StatusCodeT

RETURNS

Nothing.

DESCRIPTION

 

SEE ALSO

ixIndexWord, ixStartIndexingSession, ixIsStopWord