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

ixCreateIndex

Name

ixCreateIndex

Synopsis

void ixCreateIndex( OnixIndexManagerT IndexManager,OnixFileSpecT File, IndexModeT IndexMode, StatusCodeT *Status)

Arguments

IndexManager: The Index Manager created with ixCreateIndexManager.

File: The full path to the index you wish to create.

IndexMode: The kind of index you wish to create.

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

The simplest way to create an index is by calling ixCreateIndex. Simply pass it the path to your index and the index mode.

The index mode tells Onix whether you want to keep track of word position as well as what record each word occurs in. Only keeping track of records makes your index considerably smaller. However by keeping track of word position you can perform phrase and proximity queries.

The options are

Record Mode (1) Keeps track of only record information
Word Mode (2) Keeps track of word and record information
IDF (3) Keeps partial track of word information as well as full record information

See Also

Creating Indexes
ixCreateIndexEx, ixDeleteIndexCreationParams, ixResetIndexCreationParams, ixSetIndexCreationParams