SOM Error: Difference between revisions
Created page with "This macro reports an error condition. ==Syntax== <PRE> long errorCode; SOM_Error(errorCode); </PRE> ==Parameters== ; errorCode (long) : The integer error code for the er..." |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
This macro reports an error condition. | {{DISPLAYTITLE:SOM_Error}} | ||
This macro reports an error condition. | |||
==Syntax== | ==Syntax== | ||
long errorCode; | |||
long errorCode; | SOM_Error(errorCode); | ||
SOM_Error(errorCode); | |||
==Parameters== | ==Parameters== | ||
; errorCode (long) : The integer error code for the error to be reported. | ;errorCode (long) : The integer error code for the error to be reported. | ||
==Return Code== | ==Return Code== | ||
| Line 13: | Line 13: | ||
==Remarks== | ==Remarks== | ||
The SOM_Error macro invokes the SOMError error handling procedure with the specified error code, supplying the filename and line | The SOM_Error macro invokes the SOMError error handling procedure with the specified error code, supplying the filename and line number where the macro was invoked. The default implementation of SOMError outputs a message containing the error code, filename, and line number. Additionally, if the last digit of the error code indicates a serious error (that is, value SOM_Fatal), the process is terminated. | ||
number where the macro was invoked. The default implementation of SOMError outputs a message containing the error code, filename, | |||
and line number. Additionally, if the last digit of the error code indicates a serious error (that is, value SOM_Fatal), the process is terminated. | |||
==Related== | ==Related== | ||
===Functions=== | ===Functions=== | ||
* [[SOMError]] | * [[SOMError]] | ||
[[Category:SOM | [[Category:SOM macro]] | ||
Latest revision as of 01:53, 6 May 2020
This macro reports an error condition.
Syntax
long errorCode; SOM_Error(errorCode);
Parameters
- errorCode (long)
- The integer error code for the error to be reported.
Return Code
void
Remarks
The SOM_Error macro invokes the SOMError error handling procedure with the specified error code, supplying the filename and line number where the macro was invoked. The default implementation of SOMError outputs a message containing the error code, filename, and line number. Additionally, if the last digit of the error code indicates a serious error (that is, value SOM_Fatal), the process is terminated.