isc_install_get_message()
Go Up to API Function Reference
Returns the text of the requested error or warning message number.
Contents
Syntax
MSG_NO isc_install_get_message(MSG_NO msg_no, TEXT *msg, int msg_len)
| Parameter | Type | Description |
|---|---|---|
|
<msg_no> |
|
Message number for which text is requested; this is the return from all the InstallAPI functions. |
|
<msg> |
|
A pointer to the buffer in which the message will be returned; the message is always NULL-terminated. |
|
<msg_len> |
int |
The length of msg, in bytes; value must be at least isc_install_max_message_len. |
Description
isc_install_get message() converts the error or warning value stored in msg_no and returns the corresponding message text to the developer.
Return value
Returns zero if the function executes successfully, a positive number if an error occurs, and a negative number if the function completes but with warnings. Call isc_install_get_message() to obtain the error message when the result is nonzero.