|
A wrapper for fwException_raise(), fwUkl1Exception_raise() takes the same arguments, but will check that the exceptionText is of the form `Function(): Message', as defined by the framework, and will prepend `Unknown function(): ' to any exceptionText that does not contain `(): '.
- Parameters:
-
| exceptionInfo | An array of strings that the exception information should be appended to. |
| exceptionType | WARNING, ERROR and FATAL are permitted for this field. It is upto the user of the library to decide which is the most appropriate to use. |
| exceptionText | A string to describe the exceptional condition that occured. Must be of the form `Function(): Message' where:
- Function - the name of the function/button/thing that was executing when the when the exceptional condition arose.
- Message - description of the exceptional condition that occured, a message to the function caller.
|
| exceptionCode | A number that indicates the exception that occured. This library reserves the error code value "0" for internal use. |
- Returns:
- void.
Example (...)
int exInfoSize = dynlen(exceptionInfo);
someFunction(exceptionInfo);
if ( (exInfoSize == dynlen(exceptionInfo)) && (-1 != exInfoSize) ) {
}
else {
fwUkl1Exception_raise(exceptionInfo, "WARNING", "thisFunction(): someFunction did not execute appropriate.", "-1");
}
(...)
|