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

ixGetCurrentQueryVector

Name

ixGetCurrentQueryVector

Synopsis

OnixQueryVectorT ixGetCurrentQueryVector( OnixIndexManagerT IndexManager, DictionaryCursorT *Cursor,  StatusCodeT *Status)

Arguments

IndexManager: An Index Manager which has been created by a call to ixCreateIndexManager and been associated with an open index (by a call to ixOpenIndex) and a retrieval session started (by a call to ixStartRetrievalSession).

Cursor: A Dictionary Cursor.

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

Returns

Returns a vector with all the hits for the current key.

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

Description

ixGetCurrentQueryVector is used to get the query vector for the current word in the index.  For example, if the index's current word is the word "apple", ixGetCurrentQueryVector will return the query vector for the word "apple".

ixGetCurrentQueryVector is useful if you want to parse the queries yourself or handle certain aspects of the query manually.

IMPORTANT: In order for ixGetCurrentQueryVector to succeed, it is important to have the Cursor positioned at a actual word or key in the index.  This means that at some point before ixGetCurrentQueryVector is called a call must have been made to ixFindKey with the cursor Cursor.

See Also

Manual Queries
ixVectorCurrentHit, ixVectorNextHit, ixVectorPreviousHit