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

ixVectorCurrentHit

NAME

 ixVectorCurrentHit -- Get the current hit in the query vector.

 SYNOPSIS

void ixVectorCurrentHit(OnixQueryVectorT Vector, RecordNumT *RecordNum, RecordNumT *WordNum, RecordNumT *CountNum, FloatT *Weight, StatusCodeT *Status)

ARGUMENTS

Vector -- A vector which has been returned from a function such as ixProcessQuery.

RecordNum -- A pointer to a value of type RecordNumT. This is where the record number of the current hit is returned.

WordNum -- A pointer to a value of type WordNumT.  This is where the word number of the current hit is returned.

Count -- A pointer to a value of type RecordNumT.  This is reserved for future use.

Weight -- A pointer to a floating point value of type FloatT. This is the final weight of the record which was used when ranking. If you did not do a ranked search, the value put into Weight can simply be ignored.

Status -- A pointer to a value of type StatusCodeT.  This is where error codes and status codes are returned.  When you are at the end of the query vector, Status will be set to EndOfHitList.

RETURNS

Nothing.

If an error occurs, Status will be set to an error value ( n < 0). If you are at the end of the vector, Status will be set to EndOfHitList.

DESCRIPTION

ixVectorCurrent hit returns the current hit in a query vector.  When a query vector is returned, the current hit is the very first hit (or entry) in the vector.  ixVectorCurrentHit allows you to see what it is.  You can then use ixVectorNextHit to see what the rest of the entries are.

SEE ALSO

 ixVectorNextHit, ixVectorPreviousHit, ixVectorRewind