Skip to content

OnError - BasicReport

Provided as a hook to handle custom error reporting

Type: Event

Parameters

Parameter Type Description
ErrNum Integer the error number
Err_Line Integer the error line
ErrMsg String the error message

Syntax

Procedure OnError Integer ErrNum Integer Err_Line String ErrMsg

Description

OnError does nothing by default and is provided as a hook to handle custom error reporting. This message is designed for augmentation and should never be sent. It is sent whenever an error occurs (it is sent by Error_report.).

This message is sent by error_report (which is itself called anytime an error occurs). If you study error_report, you will see that this procedure might have already logged the error in a status log (if status_log_state is true) and might have reported the error in a message box (if display_error_state is true). Often these options will be all that is required and there will be no need to augment this message. If status_log_state is false and display_error_state is false (both of these are the defaults), then no error processing has occurred and you may wish to augment this procedure to handle an error.