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

ixEndRetrievalSession

NAME

 ixEndRetrievalSession

SYNOPSIS

void ixEndRetrievalSession(OnixIndexManagerT IndexManager, StatusCodeT *Status)

ARGUMENTS

IndexManager -- The index manager which was obtained by the call to ixCreateIndexManager() and associated with an index by a call to ixOpenIndex() and has had an indexing session started by a call to ixStartIndexingSession().

*Status  -- A pointer to the Status value which is used to return error and status conditions.

RETURNS

Nothing.

If an error condition occurs, ixEndRetrievalSession() will set Status to an error value.

DESCRIPTION

ixEndRetrievalSession() unloads an index from memory and should always be called before ixCloseIndex() if a retrieval session has been started by a call to ixStartRetrievalSession().  After this function call has been made, the index is not searchable until a subsequent call to ixStartRetrievalSession() has been made.

SEE ALSO

ixStartRetrievalSession