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

ixStartIndexingSession

NAME

 ixStartIndexingSession --  Prepares the index and memory for indexing.

SYNOPSIS

OnixIndexingEngineT ixStartIndexingSession( OnixIndexManagerT IndexManager, StatusCodeT *Status);

ARGUMENTS

 IndexManager --  An index manager as returned from ixCreateIndexManager.

 Status  -- Value of type StatusCodeT

 RETURNS

OnixIndexingEngineT

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

DESCRIPTION

ixStartIndexingSession locks the index to signal that an indexing session is in progress and then sets things up for indexing. The style of indexing (Word Level, Record Level, etc.) is determined by the settings which were used when creating the index originally.

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

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

SEE ALSO

 ixEndIndexingSession