Name

UI::AskForSaveFileName — Open a file selection box and prompt the user for a file to save data to.

Synopsis

string AskForSaveFileName ( string  startWith ,
  string  filter ,
  string  headline );

Parameters

string startWith

is the initial directory or file.

string filter

is one or more blank-separated file patterns, e.g. "*.png *.jpg"

string headline

is an explanatory text for the file selection box. Graphical UIs may omit that if no window manager is running.

Return

string

Returns the selected file name or nil if the user canceled the operation.

Description

Open a file selection box and prompt the user for a file to save data to. Automatically asks for confirmation if the user selects an existing file.