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

hiFileDialogSelection

hiFileDialogSelection(
&_dialogName
)
=> l_userSelection / nil

Description

Returns the selection made by the user in the file dialog box. This function is typically called from a user callback.

Argument

&_dialogName

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

Values Returned

l_userSelection

l_userSelection is a list of two elements, each of which is a string:

("dir" "file")

dir is a path relative to the working directory if the selection is either in the working directory or in a directory ascending or descending from it. (The working directory is specified in the t_workingDir argument of hiDisplayFileDialog.) Otherwise, dir is an absolute path.

file is the file that was selected. If the s_mode argument of hiDisplayFileDialog is ’directory or ’directoryOnly, file is an empty string.

If s_mode is ’existingFiles, l_userSelection is a list of directory-file pairs:

(("dir" "file") ("dir" "file") ...)

nil

Nothing was selected in the file dialog box or &_dialogName is not a valid file dialog ID.

Related Topics

File Selection Dialog Box Functions

hiFileDialogSelection

hiFileDialogSetSelection

hiFileDialogDone

hiGetExistingFile

hiGetExistingFiles

hiGetAnyFile

hiGetExistingDirectory


Return to top
 ⠀
X