Skip to content

Report_Interrupt - BasicReport

Called when the status panel's Cancel button has been pressed

Type: Event
Return Data Type: Integer

Syntax

Function Report_Interrupt Returns Integer

Description

Report_interrupt is called when the status panel's Cancel button has been pressed. Normally it displays a message asking the user if they wish to cancel the report. If the user selects Yes, a non-zero value is returned and the report is terminated. If a zero value is returned, the report continues. You may augment this message to present custom choices. The report is suspended at this point.

The property Error_Check_State can be queried from within this function. If it is non-zero, then the interrupt has been caused by an error.

Return Value

Return a zero value if the report is to continue, or non-zero to stop the report.