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

ixStoreRecordData

NAME

ixStoreRecordData -- Store data associated with the current record.

SYNOPSIS

ixStoreRecordData(OnixIndexingEngineT IndexingEngine, UCharT *DataBuff, size_t RecDataSize, StatusCodeT *Status);

ARGUMENTS

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

DataBuff -- A pointer to a buffer containing the data associated with the current record.

RecDataSize -- A integer of type unsigned integer (size_t)  which specifies how much data is in the buffer DataBuff (in bytes).

*Status -- A pointer to a StatusCodeT.  (This is where any errors will be reported.)

RETURNS

Nothing.

DESCRIPTION

ixStoreRecordData lets you store data with the record you are currently indexing.   At retrieval time, you can get this data back with a call to ixRetrieveRecordData.  Please note, that the only way you can take advantage of this feature is if the index was created by a call to ixCreateIndexEx() which sets up the index for storing the data.  This function can be very useful for storing such things as filenames, the record text, images, or other information associated with a given record.   The data can be stored using either a single call to ixStoreRecordData() or by multiple calls to ixStoreRecordData().  Please be aware however, that if you are working on a mission critical application, the data is not committed until the end of the current indexing session when the data is actually added to the index.

Important Note: If you store data with one record, you must store data (of non-zero length) with every record.  Otherwise, ixRetrieveRecordData() will not work properly and you may not be able to get your data back.

SEE ALSO

ixCreateIndexEx, ixRetrieveRecordData, ixRetrieveMoreRecordData, ixStoreMoreRecordData