formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File
Description
This will display the select folder dialog, and return the file locator of the folder the user selected. The folder locator must be initialized before calling this function. The result parameter will indicate the user action of the dialog, whether OK or Cancel was pressed. The dialog may be optionally customized by passing in strings for the title of the dialog, and the default name for a New Folder.
Plugin Prototype
fzrt_error_td fzrt_file_select_folder(
const fzrt_floc_ptr | start_folder, |
const char * | start_name, |
const char * | message, |
fzrt_unsigned_int | flags, |
folder, | |
result ) |
Parameters
start_folder [Input, Optional]
Start browsing from this folder. NULL to use default.
start_name [Input, Optional]
New folder name or "" for default
message [Input, Optional]
Post this message (or default message if "")
flags [Input]
Unused, must be 0
folder [Result]
Selected folder location if FZRT_STD_OK is returned
result [Result]
FZRT_STD_OK if OK pressed, FZRT_STD_CANCEL if dialog is canceled, FZRT_STD_ERROR otherwise
Returns
FZRT_NOERR is successful, error number otherwise
Availability
5.0.0.0
Function Set
Defined in