APIs, concepts, guides, and more

◆ UserError

RsiError* UserError

Allows the user to set give error details to the G-Code execution thread what occurred during the execution of the M-code callback.

This is a pointer to an RsiError object that can hold error details or a success status. The user implementing the callback should update values in UserError to indicate if the M-code was handled successfully or not.
The default value for UserError->number is RSIErrorMessage::RSIMessageOK. Update this value to anything other than RSIMessageOK and the UserError will be logged into the Robot's error log.

Use Robot::ErrorLogCountGet() to see if errors occurred during the execution of the G-code file, after GcodeDoneWait() returns.

Definition at line 916 of file cartesianrobot.h.