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

ixCharWordToHexWord

Name

ixCharWordToHexWord

Synopsis

void ixCharWordToHexWord( UCharT *HexWord, UCharT *CharWord, size_t Length)

Arguments

HexWord: A string to hold the generated hex word.

CharWord: A pointer to a regular ASCII string.

Length: The length of the ASCII string

Returns

Nothing.

Description

ixCharWordToHexWord converts an ASCII string to hexadecimal form. HexWord must be a string that is large enough to hold the hexadecimal form of CharWord. That will be approximately twice the size of the string plus 2 bytes.

The hexadecimal form of a word is used by Onix for searching so that different character sets and encodings can be searched for. Further many users embed control characters in search terms to represent special properties for a word.

The hexadecimal form starts with a 0x followed by numbers in hexadecimal form representing each byte in the string.

Many people generate queries themselves and don't wish to use ixConvertQuery2 to convert their queries. ixCharToHexWord allows them to convert individual words. You may wish to do this if, for example, your words contain characters such as & or | which the parser recognizes as query operators.

See Also

Queries
ixHexToChar, ixUnicodeHexToChar, ixUnicodeCharToHex, ixProcessQuery