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

ixStoreRecordData

Name

ixStoreRecordData

Synopsis

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

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 value of type StatusCodeT representing any error conditions.

Returns

Nothing.

If an error occurred, Status will be set to the error number.

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

Storing Data in Records
ixCreateIndexEx, ixRetrieveRecordData, ixRetrieveMoreRecordData, ixStoreMoreRecordData