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

hiFileDialogDone

hiFileDialogDone(
&_dialogName
g_accept
)
=> t / nil

Description

This function is logged when a file dialog box is dismissed. Applications do not need to call this function; it is provided for replay purposes.

This function destroys the file dialog box and resets the value of the &_dialogName symbol to nil. Do not reference a deleted file dialog box; it can cause undefined behavior.

Arguments

&_dialogName

The handle to the file dialog box, which was specified as the s_dialogName argument of hiDisplayFileDialog when the dialog box was created.

g_accept

nil if the file dialog box was canceled, non-nil otherwise.

Values Returned

t

The function was logged.

nil

&_dialogName is not a valid file dialog ID.

Related Topics

File Selection Dialog Box Functions

hiFileDialogSelection

hiFileDialogSetSelection

hiGetExistingFile

hiGetExistingFiles

hiGetAnyFile

hiGetExistingDirectory


Return to top
 ⠀
X