Core Function FileSaveDialog

Revision as of 18:27, 8 December 2011

FileSaveDialog ( <title>, <dir>, <filter>, <options>, <default name> )

Description

Initiates a Save File Dialog.

Parameters

title

Title text of the Dialog GUI.

dir

Initial directory selected in the GUI file tree.

filter

File type filter such as "All|*.*" or "Text files|*.txt"

options

Optional;

  1 = File Must Exist (if user types a filename)
  2 = Path Must Exist (if user types a path)
  4 = Allow MultiSelect
  8 = Prompt to Create New File (if does not exist)
 16 = Prompt to OverWrite File

default name

Optional; File name to suggest to the user to save the file with.

Return Value

Success: Returns the full path of the file chosen. Results for multiple selections are "Directory|file1|file2|..."

Failure: Returns empty string.

Remarks

Separate the file filters with a semicolon as shown in the example.

Note: At this time, multiple groups of filters are not supported.

If default name is given, options must also be given. If none of the options are wanted, use 0 for options.

Special Windows folders (such as "My Documents") can be sometimes be set as the init dir.

Example

$var = FileSaveDialog( "Choose a name.", @CurDir, "Scripts (*.spk)", 3);
// option 3 = dialog remains until valid path/file selected
 
If (!$var)
{
    MsgBox("Save cancelled.");
}
Else
{
    MsgBox("You chose " . $var);
}