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

# fz_fuim_prog_stage_init

Description

Initialize a progress stage. This function indicates the start of a stage of the progress bar. The progress of the stage is communicated to the progress bar by specifying the range of the stage and then subsequent calls to to move the indicator along the range (from min to max). To make a smooth progress bar, find a good way of measuring the range of the task and the progress of the task. The range (max - min) should be greater than 400.
If the current stage has not been finalized with , it is automatically finalized starting the new stage.

Plugin Prototype

fzrt_error_td fz_fuim_prog_stage_init(

char * | name,
fzrt_int | min,
fzrt_int | max )

Parameters

name [Input]

name of the stage (appears in the title bar of the progress bar)

min [Input]

minimum value for stage range

max [Input]

maximum value for stage range

Returns

Error codes

Availability

5.0.0.0

See Also

,

Function Set

fz_fuim_fset

Defined in

fz_fuim_prog_api.h