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

ixVectorPreviousHit

Name

ixVectorPreviousHit

Synopsis

void ixVectorPreviousHit( OnixQueryVectorT  Vector, RecordNumT *RecordNum, RecordNumT *WordNum, RecordNumT *Count, 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.

Returns

Nothing.

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

Description

ixVectorPreviousHit is used to find out what the prior 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.

See Also

Queries, Manual Queries
ixVectorCurrentHit, ixVectorNextHit, ixVectorRewind