Onix Text Retrieval Toolkit
API Reference

Function List
Topical List

Main Index

Calling Sequences
Query Processing
Relevancy Ranking
Data Types
Error Handling
Lextek Products
Onix Text Retrieval Engine
Lextek Document Profiler & Categorizer
Brevity Document Summarizer
RouteX Routing Engine
Language Identifier





void ixVectorNextHit( OnixQueryVectorT  Vector, RecordNumT *RecordNum, RecordNumT *WordNum, RecordNumT *Count, FloatT *Weight, StatusCodeT *Status)


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 representing any error conditions.



If an error occurred, Status will be set to the error number. When you are at the end of the query vector, Status will be set to EndOfHitList.


ixVectorNextHit is used to find out what the next hit is in the query vector.  It returns both the record number and the word number of the current hit.  If you are using a record level index, you will not need to pay attention to the word number. Generally, when walking through the query vector (or hit list) viewing all of the hits, ixVectorNextHit is only called after a call to ixVectorCurrentHit.  (When called with a new vector ixVectorCurrentHit gets the first hit in the vector and ixVectorNextHit is used to get the rest.)

See Also

Queries, Manual Queries
ixVectorCurrentHit, ixVectorPreviousHit, ixVectorRewind