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

ixIndexNumber

Name

ixIndexNumber

Synopsis

void ixIndexNumber(OnixIndexingEngineT IndexingEngine, UCharT *Prefix, UCharT PrefixLength, ULongT Number, StatusCodeT *Status)

Arguments

IndexingEngine: Indexing engine which you obtained via the call to ixStartIndexingSession.

Prefix: A string containing an optional prefix.

PrefixLength: The length of the prefix string.

Number: The number to be indexed.

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

ixIndexNumber allows you to index numbers as actual numbers and not just as strings. A number can be indexed as both a number and a string in the same location by calling ixIndexWordSpecial. These numbers can then be searched for in a query using the form #.00#.

The optional prefix is used to prepend a custom string to the number. This allows you to distinguish different kinds of numbers. For instance you might wish to index phone numbers as numbers but distinguish them from regular integers you index. Any string can be prepended to the number. For instance you may use the string PH to distinguish a phone number. You'd then index the number 655-1994 with

ixIndexNumber( myindexer, "PH", 2, 3758332, Status);

Note that you search for numbers you index by enclosing the number in pound signs with a hexadecimal form of your prefix followed by a . and the number. So if you had called ixIndexNumber(myEngine, " ", 1, 20, myStatus) you'd search for it via the term #0x1A.20# where 1A is the hexadecimal form of a space character.

See Also

Indexing
ixStartIndexingSession, ixEndIndexingSession, ixIndexWord, ixIndexWordSpecial