If an error occurs for a situation where the user has registered an
'error-handling callback function', then that user-defined function
is called, and is passed, among other items, two pointers to
user-defined messages. The pointer for the first of those messages
is set by this call. The pointer to the second message is set by the
SE_SetSecondErrorMessage()
function. These messages are left to the user to define and change
as often as desired. The intent of these messages is to give the user
the ability to construct an intelligent error message that can give
the user a good idea as to what was occurring within the user's code
when the error occurred. The text of the message 'lives' entirely
within the user's memory space. This API never attempts to copy the
message and never accesses the message. The API simply stores the
pointer and passes the pointer to the appropriate user-defined
error-handling callback function at appropriate times.
| extern void | ||||
| SE_SetFirstErrorMessage | ||||
| ( | ||||
| const | char | * | msg | (notes) |
| ); | ||||
a pointer to the user-defined error message. If NULL,
'clears' the pointer.