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

# fz_fuim_prog_stage_set_strings

Description

Set the current progress information and detail strings. The information string is usually a description of the task progress and often is the subject for the detail string. For example, when reading a file the information string could be "Lines Read:" and the detail string could be the actual number of lines currently read. In this type of implementation the function is called once immediately after a fz_fuim_prog_stage_init with the information string. It is then called immediately before each call to set the detail string.
Note that for progress bars initialized with FZ_FUIM_PROG_KIND_NORMAL, the space for the strings is small and the strings appear side by side with the information string on the left and the detail on the right. For progress bars initialized with FZ_FUIM_PROG_KIND_EXPANDED, the information string is the width of the progress bar and the detail string appears below it and can contain up to three lines.

Plugin Prototype

fzrt_error_td fz_fuim_prog_stage_set_strings(

char * | prog_info,
char * | prog_detail )

Parameters

prog_info [Input, Optional]

string for the progress information field

prog_detail [Input, Optional]

string for the progress detail field

Returns

Error codes

Availability

5.0.0.0

See Also

fz_fuim_prog_stage_init,, fz_fuim_prog_stage_get_strings

Function Set

fz_fuim_fset

Defined in

fz_fuim_prog_api.h