|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE SetFirstErrorMessage |
|---|
| extern SE_Return_Code | ||||
| SE_SetFirstErrorMessage | ||||
| ( | ||||
| const | SE_String | * | message | 1 |
| ); | ||||
If an error occurs for a situation where the user has registered an error-handling callback function, that user-defined function is called, and is passed, among other items, two user-defined messages. The first of those messages is set by this function. The second message is set by the SE_SetSecondErrorMessage() function. The intent of these messages is to give the user the ability to construct an intelligent error message that can give an indication as to what was occurring when the error occurred.
| SE_RETCOD_SUCCESS | all operations succeeded. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set upon successful completion. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_INACTIONABLE_FAILURE | set upon failure. |
1 a handle to the user-defined error message. If NULL, 'clears' the pointer.
Prev: SE_SetColourModel.
Next: SE_SetGeneralCallback.
Up:Index.
|