The Main Manual Page Dynamic API Documentation CD-ROM API Documentation About Onix Types About Onix Errors Onix's Web Site at Lextek International Lextek International Onix Full Text Indexing and Retrieval Toolkit

ixGetStatusMessage

NAME

 ixGetStatusMessage -- Get an error message if an error exists.

SYNOPSIS

void ixGetStatusMessage(StatusCodeT *Status, char *StatusMessageBuff)

ARGUMENTS

Status -- A pointer to a variable of type StatusCodeT which contains the status code in question.

StatusMessageBuff -- A character pointer to an empty buffer.

RETURNS

 Nothing

DESCRIPTION

ixGetStatusMessage copies a status message corresponding to the value in StatusCodeT into the buffer StatusMessageBuff.  This can be used to detect and report errors.

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.