formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File
Description
Displays a multiple select Get File dialog. This will display a Get File dialog that will allow the user to select multiple files. If the user cancels the dialog, this function will return FZRT_NOERR. The result parameter will indicate the action of the user, if the function is successful. The list of file locators is returned by the filetab argument. Use the fzrt_file_get_one_file function to retrieve the individual file locators from the file table. The caller must call fzrt_file_get_multiple_files_end to release the memory associated with the file table. For a description of the dialog file filter, see .
Plugin Prototype
fzrt_error_td fzrt_file_get_multiple_files_begin(
const fzrt_floc_ptr | start_folder, |
const char * | message, |
entrytab, | |
fzrt_int | count, |
fzrt_int | start_id, |
fzrt_unsigned_int | flags, |
filetab, | |
fzrt_int * | knt, |
result ) |
Parameters
start_folder [Input]
File locator - start browsing from this folder
message [Input, Optional]
Post this message (or default message if "")
entrytab [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
flags [Input]
Unused. Must be 0
filetab [Result]
Pointer to selected files storage - this is created by get_multiple_files_begin
knt [Result]
Returned selected file count (if zero FZRT_CANCEL was selected)
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_get_one_file, fzrt_file_get_multiple_files_end,
Function Set
Defined in