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

hiSetCallbackStatus

hiSetCallbackStatus( 
r_form 
g_booleanStatus 
) 
=> t / nil 

Description

Overrides the removal (unmapping) of a form when the form’s OK button is pressed.

This function can be used in the form’s callback and is useful if you enter invalid form data and the application instructs you to re-enter a response.

To use this function, you must set the unmapAfterCB flag argument of hiCreateAppForm to t.

Arguments

r_form

Form description returned from hiCreateAppForm or hiCreateForm.

g_booleanStatus

Desired status of the form. This booleanStatus is a toggle value, and must be reset to t once it has been set to nil. The form will not be brought down until this value is reset. This routine should only be used with standard forms; the user should never try to override the actions of an options form. Each form will have its initial status set (default is t) to hide the form when OK is pressed. This value is reset to t if the user cancels the form.

Value Returned

t

The function was successful.

nil

An error occurred. An error message is also issued.

Related Topics

Form and Field Functions

hiCreateAppForm

hiCreateForm


Return to top
 ⠀
X