GetFileSave

The GetFileSave function uses the Windows Save dialog to browse for a file name string. If the [Save] button is clicked, the full path name of the file is returned. This function does not actually save the file.

Syntax

sName = GetFileSave( tblParams )

sName = GetFileSave()

tblParams is an optional table containing values from the FileNameParams table. If omitted, default FileNameParams values are used.

If the [Save] button is clicked, the full file path is returned as sName.

If the dialog was closed using [Cancel] or [X], nil is returned.

Examples

The scripts below show the use of GetFileSave with and without overriding the FileNameParams values.

sName = GetFileSave()	-- use the default GetFileSave dialog
if sName then Printf("name=%s\n",sName) end	-- exit the script if sName is nil

Params =	-- setup a table with FileNameParams overrides
{	-- (use a comma after each value)
sSaveTitle = "Save the Source File",	-- the new title for the Save dialog
}
str = GetFileSave(Params)	-- use GetFileSave with new properties

Params =	-- setup a FileNameParams table
{	-- (use a comma after each value)
sSaveTitle = "Save the Source File",	-- the new title for the Save dialog
}
str, NewParams = GetFileSave(Params)	-- use GetFileSave and use the returned properties
if str ~= nil then	-- check that valid results are returned
Printf("Ext=%s\n", NewParams.sFileExt)	-- list the new file extension
end

Syntax

Examples

Related Topics