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

ixAbortIndexingSession

Name

ixAbortIndexingSession

Synopsis

void ixAbortIndexingSession( OnixIndexingEngineT IndexingEngine, StatusCodeT *Status)

Arguments

IndexingEngine: An indexing session object created with ixStartDistributedIndexingSession or ixStartIndexingSession.

Status: A pointer to a value of type StatusCodeT.  If an error occurs, it will be reported in *Status.

Returns

Nothing.

If an error occurred, Status will be set to the error number.

Description

To abort an indexing session call ixAbortIndexingSession. Typically you will only need to call this with multithreaded applications. In multithreaded applications one thread may be finishing the indexing process inside of ixEndIndexingSession or ixEndDistributedIndexingSession. Ending the session merges multiple temporary indexes into the main index. This can, with a large amount of newly indexed data, take some time. If you have provided for the user an interface to cancel the process you need to be able to break out of this merging of indexes. This function will let you do this. Simply call this function within a separate thread it will break out of the merging process.

Be sure after calling ixAbortIndexingSession to call ixForceCloseOfTemporaryFiles to delete any files that may not have been properly closed when the process exited. (It is a separate function call so as to allow immediate feedback to users of the application)

See Also

Indexing
ixForceCloseOfTemporaryFiles, ixEndIndexingSession, ixEndDistributedIndexingSession