Profiling Engine SDK
API Reference

API
Function List
Topical List
   
 
Query Language
Introduction
Summary
Operators
Tips, Questions, and Answers
   
 
Main Index
Index
Tutorial
API Functions
Query Language
   
Technology Overview
   
Contact Us
   
 
Other Products

Onix Text Search and Retrieval Engine
Brevity Document Summarizer
Lextek Document Profiler & Categorizer
RouteX Document Routing Engine
Lextek Language Identifier
 

prNumHits

Name

prNumHits

Synopsis

void prNumHits( OnixQueryVectorT Vector, UFloatT *VecWeight, ULongT *NumHits, ULongT *NumRecords, ULongT *NumWords, StatusCodeT *Status)

Arguments

Vector: The list of hits you wish statistics on.

VecWeight: A pointer to a float with the overall weight of the vector. (Currently unused)

NumHits: A pointer to a long integer with the total number of hits in the vector.

NumRecords: A pointer to a long integer with the total number of unique records in the vector.

NumWords: A pointer to a long integer with the total number of words in the vector. (For compatibility with Onix - is the same as NumHits for the Profiling Engine)

Status: A pointer to a value of type StatusCodeT representing any error conditions.

Returns

Nothing.

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

Description

prNumHits() gives you statistics on the vector returned by prProcessQuery(). It will tell you both the total number of hits and the total number of unique records in the vector.

Typically you will call prNumHits() prior to iterating over the hits in the vector using prVectorNextHit().

See Also

prProcessQuery, prVectorNextRecord, prVectorNextHit, prVectorCurrentHit, prResetProfilerQueryParser