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

ixNumHits

NAME

 ixNumHits

SYNOPSIS

void ixNumHits(OnixQueryVectorT Vector, ULongT *NumHits, ULongT *NumRecords, ULongT *NumWords, StatusCodeT *Status)

ARGUMENTS

Vector  -- A Vector which (probably) has hits in it.

NumHits  --  Pointer to an unsigned long.  This is where the number of hits will be returned.

NumRecords  -- A pointer to an unsigned long.  This is the number of records which match the query.  For record level indexes, this is the same as the NumHits.

NumWords  -- Pointer to an unsigned long.  This is the number of words which match the query in this result vector.  Used primarily for Word Level indexes.  With word level indexes, this is the same as NumHits.

Status  -- A Pointer to an object of type StatusCodeT.  If an error occurs, it will be reported in this value.

RETURNS

 Nothing.
 If an error occurs, it will be reported in Status.

DESCRIPTION

ixNumHits reports the number of hits which are stored in a query vector.  NumHits is the actual number of entries that are stored in the query vector.  NumRecords, and NumWords both report the number of records or words (respectively) which match the query.

If you are working with record level indexes, it is generally better to watch NumHits rather than NumRecords.

SEE ALSO

ixVectorPreviousHit, ixVectorCurrentHit, ixVectorNextHit