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

fz_fuim_script_run_dialog_windex

Description

Runs a dialog with the window index of a project being passed in. 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 is passed in, which sets up the dialog template and dialog items. 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(fzrt_int windex, 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. This function is the same as fz_fuim_script_run_dialog, except that windex is passed in and passed through to the callback function.

Parameters

windex [Input]

project window index

dialog_func [Input]

name of dialog template callback function

Returns

FZRT_STD_OK or FZRT_STD_CANCEL

Availability

5.0.0.0