Process_Interrupt - BusinessProcess

Called by Cancel_Check if a user response is required to determine if a process should be canceled

Type: Event
Return Data Type: Integer

Syntax

Function Process_Interrupt Returns Integer

Description

Process_Interrupt is called by Cancel_Check if a user response is required to determine if a process should be canceled. It is expected that the function will present some kind of interface object (like a message box) and ask users if they wish to cancel.

By default, it presents a YesNo_Box informing user that either the Cancel key was pressed or an error occurred and asking if the process should be halted. It returns non-zero to cancel.

You are expected to augment this message, not to call it.

Col 1	Col 2
Note:	Process_Interrupt is only called by Cancel_Check, even if an error occurs. Thus, if you want to allow the user to stop the BusinessProcess if an error occurs during processing, you must call Cancel_Check from OnProcess.

The default text displayed in the dialog is C_$AnErrorWasEncountered if an error ocurred, otherwise C_$DoYouWishToCancelThisProcess is shown.

Return Value

Returns True when the user clicked the YES button in the default Yes/No dialog.