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

ixVectorNextRecord

NAME

ixVectorNextRecord -- Get the next record in the query vector

SYNOPSIS

ixVectorNextRecord(OnixQueryVectorT Vector, RecordNumT *RecordNum, WordNumT *WordNum, RecordNumT *Count, FloatT *Weight, StatusCodeT *Status);

ARGUMENTS

Vector -- A Query Vector created by ixProcessQuery or ixCreateResultVector()

RecordNum -- A pointer to a integer of type RecordNumT.  The next record number will be placed here.

WordNum -- A pointer to an integer of type RecordNumT.  The first word number for the next record will be placed here if you have a WordLevel index.

Count -- A pointer to an integer of type RecordNumT.  The number of times this word occurs will be placed here assuming the index is of type IDF.

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 StatusCodeT.  If an error occurs, Status will be set to the appropriate value.  At the end of the Query Vector, Status will be set to EndOfHitList.

RETURNS

Nothing.

DESCRIPTION

ixVectorNextRecord is almost identical to ixVectorNextHit except that it advances to the next record stored in the query vector and not the next hit.  This is useful for WordLevel indexes where you may not want to advance one by one through all the matching words within a record.  For Record or IDF mode indexes, ixVectorNextRecord will function identically to ixVectorNextHit.  When advancing through the query vector and the end is reached, Status will be set to EndOfHitList.

SEE ALSO

ixVectorPreviousRecord, ixVectorCurrentHit, ixVectorPreviousHit, ixVectorNextHit