Onix Text Retrieval Toolkit
API Reference

API
Function List
Topical List

Main Index

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

ixNumHits

Name

ixNumHits

Synopsis

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

Arguments

Vector: The vector with any hits.

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 a value of type StatusCodeT representing any error conditions.

Returns

Nothing.

If an error occurred, Status will be set to the error number.

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

Queries
ixVectorPreviousHit, ixVectorCurrentHit, ixVectorNextHit