rgetlmsg()

Returns the error message for a specified error number, which can be a 4-byte integer.

Syntax

int4 rgetlmsg(int msgnum, char *s, mint maxsize, mint *msg_length);
  1. msgnum is the error number. The four-byte parameter provides for the full range of Informix-specific error numbers.
  2. s is a pointer to the buffer that receives the message string (the output buffer).
  3. maxsize is the size of the msgstr output buffer. Make this value the size of the largest message that you expect to retrieve.
  4. msg_length is a pointer to the mint that contains the actual length of the message that rgetlmsg() returns.

Returns

Table 1. Return codes
Code Description
0 The operation was successful.
-1227 Message file not found.
-1228 Message number not found in message file.
-1231 Cannot seek within message file.
-1232 Message buffer is too small.
Important: This function returns Informix® specific messages; it will not work properly if the Informix client software is not installed.