Skip to content

Check_StatusPanel - cProcessStatusPanel

Returns a status value from the status panel, usually used to determine whether the user wants to cancel (abort) a process.

Type: Function
Return Data Type: Integer

Syntax

Function Check_StatusPanel Returns Integer

Call Example

Get Check_StatusPanel to IntegerVariable

Description

Check_StatusPanel returns a status value from the status panel, usually used to determine whether the user wants to cancel (abort) a process.

Get Check_StatusPanel of ghoStatusPanel to bUserCancel
If (bUserCancel) Begin
    // do clean up events after cancel.
End

This typically needs to be used in conjunction with Allow_Cancel_State set to True to allow the user to click on a Cancel button.

Return Value

Normally, a non-zero return value means that the process has been canceled.