ask file

Displays a standard Save dialog box for the user to enter a file name and specify a location.

# Metadata

Platforms: desktop OS: mac, windows, linux Introduced: 1.0 Security: disk

# Syntax

ask file prompt [with defaultFilePath] [with filter types] [as sheet]

# Params

- prompt : If you specify empty, no prompt appears. - defaultFilePath : The defaultFilePath consists of a folder path, or a suggested file name, or both. The filename is the portion of the path after the last slash character (/). If a folder path is provided in the defaultFilePath, the dialog box shows the contents of that folder. Otherwise, it shows the contents of the last folder you used with a file dialog box. If a suggested file name is provided in the defaultFilePath, it appears in the file name box. - types : The types parameter specifies which extensions are available at the bottom of the dialog box. A file type consists of an optional description, a line feed or comma, and a file extension specification: [description],*.extension You can include more than one file type by separating the file types with commas. >*Cross-platform note:* The <types> <parameter> applies only to > <Windows|Windows systems>. On <Mac OS> and <Unix|Unix systems>, this > <parameter> has no effect.

# Examples

ask file "Please name the file:"

ask file "Save data as" with "/HD/Data Stacks/filedata.rev" as sheet

ask file empty with "Untitled"

ask file "Export picture as:" with filter "JPEG file,*.jpg"

# Description

Use the ask file command to let the user provide the file path of a new file.

The dialog box is the same one most applications use for the "Save" command in the File menu. (If the systemFileSelector property is set to true on Mac OS and Windows, and always on Unix, the application displays its own built-in dialog box, instead of the one provided by the operating system.)

>*Important:* The ask file command does not create the file. It only > displays the dialog box and retrieves the path to the file the user > specifies.

>*Note:* On Windows, it is imperative not to name a file with one of the > reserved device names: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, > COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, > LPT7, LPT8 and LPT9. Also do not use these names followed by an > extension, for example, NUL.tx7. If the as sheet form is used, the dialog box appears as a sheet on OS X systems. On other systems, the as sheet form has no effect and the dialog box appears normally. Attempting to open a sheet from within another sheet displays the second stack as a modal dialog box instead.

If the systemFileSelector property is set to false, LiveCode's built-in dialog box is used instead of the operating system's file dialog box.

>*Cross-platform note:* On Mac OS where Navigation > Services is in use, if you don't specify a default file name, the file > name box contains "untitled". On Unix and Windows systems, the file > name box is empty when the dialog box appears. Unix systems > currently use LiveCode's built-in dialog box.

# Tags

file system,

# See

- **keyword:** file, it - **command:** answer file, ask - **function:** result - **control structure:** function - **glossary:** application, return, variable, property, file path, modal dialog box, dialog box, command, Windows, file dialog box, Mac OS, Unix, parameter