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

# fzrt_file_dlg_filter_set

Description

Sets the entry of dialog file filter. This will set the specified entry in a dialog filter for the Get File/Save dialog. The specified entry must be less than the count passed into fzrt_file_dlg_filter_new. The file_id must be a unique number for every entry in the dialog file filter.
The extensions string can contain up to FZRT_STDF_MAX_NUM_EXT extensions. Each extension must be less than FZRT_STDF_MAX_EXT characters. The extensions are separated by the colon ':' character. If this string contains more than FZRT_STDF_MAX_NUM_EXT extensions, only the first FZRT_STDF_MAX_NUM_EXT extensions will be used. The menu_name is a C string.

Plugin Prototype

fzrt_error_td fzrt_file_dlg_filter_set(

fzrt_file_dlg_filter_ptr | dlg_filter,
fzrt_int | index,
fzrt_int | file_id,
fzrt_ostype | type,
char * | extensions,
char * | menu_name )

Parameters

dlg_filter [Input]

pointer to a file dialog filter. Must be created with fzrt_file_dlg_filter_new

index [Input]

index of entry to set in file dialog filter 0-based

file_id [Input]

unique ID of entry in dialog filter

Range: file_id >= 2

type [Input]

Macintosh file type (Macintosh only)

extensions [Input]

file extensions. Must be a C string

menu_name [Input]

Description of file type. C string not longer than 256 characters

Returns

FZRT_NOERR is successful, error number otherwise

Availability

5.0.0.0

See Also

fzrt_file_dlg_filter_new, fzrt_file_get_multiple_files_begin,

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h