- 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 | |
ixGetStatusMessage
Name
ixGetStatusMessage
Synopsis
void ixGetStatusMessage(StatusCodeT *Status, char *StatusMessageBuff)
Arguments
Status: A pointer to a value of type StatusCodeT representing any error conditions.
StatusMessageBuff: A character pointer to an empty buffer.
Returns
Nothing.
Description
Returns the current status as a text string. This is useful for obtaining a "human readable" version of an error. This may be used in the future to provide additional information about the error.
While there isn't a hard and fast rule as to how long the buffer needs to be, a buffer 255 characters in size is more than long enough. (Most status messages are actually quite short.)
As a point of note, values for Status which are less than 0, are errors. A value of 0 means no error occurred. A value above 0, is simply a status code which some functions use.
See Also
Status Information
ixGetStatusMessage