The RsiError object contains information about any RapidCode API object's error/exception. More...
Attributes | |
char | functionName [RSI_ERROR_TEXT_SIZE] |
Function name of the raised the error. | |
bool | isWarning |
Whether the error is or is not a warning. | |
int32 | lineNumber |
Source code line number. | |
RSIErrorMessage | number |
Error number. | |
char | shortText [RSI_ERROR_TEXT_SIZE] |
Error short text. | |
char | text [RSI_ERROR_TEXT_SIZE] |
Error message text. | |
Functions | |
virtual const char * | what () const throw () |
Returns a null terminated character sequence that may be used to identify the exception. | |
The RsiError object contains information about any RapidCode API object's error/exception.
RSIErrors are thrown from RapidCode API calls and provide useful information for diagnostics and debugging. Objects and all data members are created on the stack and the RsiError object itselt is thrown. The preferred catch is by const reference, but by value will work, too. It is safe to assume that every RapidCode API call can throw an RsiError.
Exception throwing can be disabled for an object instance using ::ThrowExceptions(false) and enabled using ::ThrowExceptions(true). It can be disabled across then entire API by calling this function on the MotionController instance if set to false, a log of RsiErrors can be accessed using ::ErrorLogGet()