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

ixVectorCurrentHit

Name

ixVectorCurrentHit

Synopsis

void ixVectorCurrentHit( OnixQueryVectorT Vector, RecordNumT *RecordNum, RecordNumT *WordNum, RecordNumT *CountNum, FloatT *Weight, StatusCodeT *Status)

Arguments

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. When you are at the end of the query vector, Status will be set to EndOfHitList.

Returns

Nothing.

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

Description

ixVectorCurrent hit returns the current hit in a query vector.  When a query vector is returned, the current hit is the very first hit (or entry) in the vector.  ixVectorCurrentHit allows you to see what it is.  You can then use ixVectorNextHit to see what the rest of the entries are.

See Also

Queries, Manual Queries
ixVectorNextHit, ixVectorPreviousHit, ixVectorRewind