formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File

# fzrt_file_put_file

Description

Displays the Save File dialog. This will display the default system's save file dialog. The result parameter indicates whether the user click OK, Cancel, or if an error occurred. The destination file locator is returned in the out_file argument, if the user presses the OK/Save button, and the result is FZRT_STD_OK. The caller can create a filter of which files to save as using the dlg_filter. The file_id argument will contain which entry in the dialog filter was selected by the user, as an indication of the Save as file type. If the user passes NULL for dlg_filter, the result of file_id is undefined. The initial name of the saved file name is passed as a string in the start_name parameter.

Plugin Prototype

fzrt_error_td fzrt_file_put_file(

const fzrt_floc_ptr | start_folder,
const char * | start_name,
const char * | message,
fzrt_file_dlg_filter_ptr | dlg_filter,
fzrt_int | count,
fzrt_int | start_id,
fzrt_floc_ptr | out_file,
fzrt_int * | file_id,
fzrt_std_enum * | result )

Parameters

start_folder [Input]

File locator - start browsing from this folder

start_name [Input]

default name for saved file)

message [Input, Optional]

Post this message (or default message if "")

dlg_filter [Input, Optional]

If not NULL a menu with formats appears in the open/close dialogs

count [Input]

Count of entries in the file filter menu

start_id [Input]

Start-up file ID of filter

out_file [Result]

file locator of selected file if FZRT_STD_OK returned

file_id [Result, Optional]

the file id of entry in dlg_filter selected when OK is pressed

result [Result]

FZRT_STD_OK if OK pressed, FZRT_STD_CANCEL if Cancel pressed, FZRT_STD_ERROR otherwise

Returns

FZRT_NOERR is successful, error number otherwise

Availability

5.0.0.0

See Also

fzrt_file_dlg_filter_new,

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h