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

ixStartIndexingSession

Name

ixStartIndexingSession

Synopsis

OnixIndexingEngineT ixStartIndexingSession( OnixIndexManagerT IndexManager, StatusCodeT *Status)

Arguments

IndexManager: An index manager as returned from ixCreateIndexManager.

Status: A pointer to a value of type StatusCodeT representing any error conditions.

Returns

OnixIndexingEngineT, the indexing object used in all indexing function calls.

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

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.

See Also

Indexing
ixEndIndexingSession, ixIndexWord, ixIncrementRecord