Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiDBoxCancel

hiDBoxCancel( 
g_dboxID 
[ g_cancelFromCancel ] 
) 
=> t / nil

Description

Function logged when either the Cancel or the No button is pressed on a dialog box. This function can also be called directly from SKILL to simulate pressing No or Cancel.

If g_cancelFromCancel is non-nil in the logged entry, that indicates that the Cancel button was pressed when both No and Cancel buttons are present in the dialog box.

Arguments

g_dboxID

ID of the dialog box being canceled.

g_cancelFromCancel

  

Optional argument to be used when a form has both a No and Cancel button. The valid values for this argument are:

Any non-nil value: Simulate pressing Cancel if the dialog box has a No button.

nil: Simulate pressing No if the dialog box has both No and Cancel buttons, otherwise simulate pressing Cancel.

The default value of this argument is nil.

Values Returned

t

The function was logged.

nil

g_dboxID is invalid.

Related Topics

General Dialog Box Functions

hiDisplayAppDBox

hiDBoxOK


Return to top
 ⠀
X