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

ixStartDistributedIndexingSession

NAME

 ixStartDistributedIndexingSession --  Prepares the index and memory for indexing data to be added to a distributed index..

SYNOPSIS

OnixIndexingEngineT ixStartIndexingSession(OnixIndexCreationParamsT Options, StatusCodeT *Status);

ARGUMENTS

Options -- Index options that are the same as those set when the index was originally created via a call to ixCreateIndexEx().

 Status  -- Value of type StatusCodeT

 RETURNS

OnixIndexingEngineT

If an error occurs, the value Status will be set to an error value.

DESCRIPTION

ixStartDistributedIndexingSession sets things up for a distributed indexing session.

Sometimes, it is advantageous to have more than one machine, process, or thread indexing data for the same index. When this is the case, ixStartDistributedIndexingSession() allows you to create a new IndexingEngine all ready for indexing without a corresponding index. (That way the new index data can be added to a previously existing index later.)

An OnixIndexingEngineT is returned from this function which is used by the functions ixIndexWord, ixIncrementRecord, and ixEndDistributedIndexingSession.

At some point during the course of the indexing session, the final file name for the new index data needs to be set by a call to ixSetFinalIndexDataPosition. If a file by that name already exists, it will be overwritten.

If an error occurs in setting things up for indexing, the status code will be set to an error value.

SEE ALSO

 ixEndDistributedIndexingSession, ixSetFinalIndexDataPosition, ixIndexWord, ixIncrementRecord