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

ixEndDistributedIndexingSession

NAME

 ixEndDistributedIndexingSession

SYNOPSIS

void ixEndDistributedIndexingSession(OnixIndexingEngineT IndexingEngine, StatusCodeT *Status)

ARGUMENTS

IndexingEngine -- IndexingEngine which you obtained from the call to ixStartDistributedIndexingSession().

*Status  -- Pointer to the Status value of type StatusCodeT.

RETURNS

 Nothing.

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

DESCRIPTION

ixEndDistributedIndexingSession tells the indexing engine that you are finished indexing the text.  (It also should only be called if you have started an indexing session with a call to ixStartDistributedIndexingSession().)  From this point, the indexing engine will process the index you have created, compress it, and store it in a searchable form.  This is a significant amount of processing so don't be surprised if this function does not return immediately.  In addition, the IndexingEngine which you have been using will be automatically deleted by this function. 

Note: If you have not already called ixSetFinalIndexDataPosition during the indexing session, do it now before calling ixEndDistributedIndexingSession(). If you don't an error will occur.

When this function returns, the data in the index file is ready for searching.  However, it is not yet part of any index. To add it to an index, you will need to call ixAppendDistributedDataToIndex().

SEE ALSO

 ixStartDistributedIndexingSession, ixIndexWord, , ixIncrementRecord, ixAppendDistributedDataToIndex.