The Main Manual Page Dynamic API Documentation CD-ROM API Documentation About Onix Types About Onix Errors Onix's Web Site at Lextek International Lextek International Onix Full Text Indexing and Retrieval Toolkit

ixGetCurrentQueryVector

NAME

 ixGetCurrentQueryVector -- Get the index for the current index key.

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.

RETURNS

Nothing.

If an error occurs, Status will be set to an error value.

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

ixVectorCurrentHit, ixVectorNextHit, ixVectorPreviousHit