- 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 | |
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: 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
Returns record id information for a given record number. Record ids are used to synchronize the Onix database with other external databases such as SQL tables. You can store record id information that then references some unique identifier in an other table.
Unlike storing general data with a record, using record ids allows you more flexibility in doing complex queries that may need to access other databases or information.
See Also
Record IDs
ixIndexWord, ixStartIndexingSession, ixIsStopWord