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

ixEndIndexingSession

Name

ixEndIndexingSession

Synopsis

void ixEndIndexingSession(OnixIndexManagerT IndexManager, OnixIndexingEngineT IndexingEngine, WordTypeT *Word, StatusCodeT *Status)

Arguments

IndexManager: IndexManager which you obtained when you called ixCreateIndexManager and then associated with an index by a call to ixOpenIndex.

IndexingEngine: IndexingEngine which you obtained from the call to ixStartIndexingSession.

Word: Pointer to the Word structure which you have been using to index the text.

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

ixEndIndexingSession tells both the indexing engine and the index manager that you are finished indexing the text.  (It also should only be called if you have started an indexing session with a call to ixStartIndexingSession.)  From this point, both the indexing engine and index manager 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.  When this function returns, the data in the index is ready for searching.  You will need to call ixStartRetrievalSession before performing any searches however.

See Also

Indexing
ixStartIndexingSession, ixIndexWord, ixFinalProcessIndex, ixMakeIndexActive