formZ SDK | 5.0 API Reference | System | User Interface (FUIM) | Templates

# fz_fuim_tmpl_init

Description

Initialize interface template. This function must be the first function called in an interface setup function. The titl_str parameter is shown in the name of the dialog or palette window title bar.
The UUID and version are provided so that formZ can maintain some persistent information about the template so that is kept in same state when it is invoked the next time. This includes settings like the active tab in tab controls, the collapse state for groups in palettes etc. This information is also used to automate the predefined settings menu which is present next to the reset button (when a UUID is provided). The version number should start at 0 and if the content of the template is changed, the version number should be increased so that formZ can properly handle persistent information from previous versions.

Plugin Prototype

fzrt_error_td fz_fuim_tmpl_init(

fz_fuim_tmpl_ptr | fuim_tmpl,
char * | titl_str,
short | tmpl_flags,
fzrt_UUID_td | uuid,
fzrt_int | version )

Parameters

fuim_tmpl [Input]

pointer to fuim template

titl_str [Input]

name of template.

tmpl_flags [Input]

options flags for template. Exists for future compatibility. Should always be 0

uuid [Input, Optional]

UUID for template

version [Input]

version for template

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_setup_func, fz_fuim_setup_data_func, fz_fuim_setup_windex_func

Function Set

fz_fuim_fset

Defined in

fz_fuim_api.h