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

fz_fuim_script_run_dialog

Description

Runs a dialog. Program execution Control stays within the dialog until the dialog is closed by the user, pressing OK or Cancel. The name of the callback function, which sets up the dialog template and dialog items is passed in. This callback function can have any name, but must fit the required return type and arguments. The function definition for the callback function is :

fzrt_int my_dialog_func( fz_fuim_tmpl_ptr fuim_tmpl);

This function should first initialize the template calling fz_fuim_script_tmpl_init. One or more dialog items can be created with the respective fz_fuim_script_new... function and variables can be attached to an item with the fz_fuim_script_item_range... functions. The dialog callback function should return FZRT_NOERR, if it succeeds and an error if it does not.

Parameters

dialog_func [Input]

name of dialog template callback function

Returns

FZRT_STD_OK or FZRT_STD_CANCEL

Availability

5.0.0.0