hiSetProgress

hiSetProgress(
g_dboxID
x_step
)
=> t / nil

Description

Sets the progress bar in a progress dialog box to the step you specify. Note, however, that the text above the progress bar remains the same; use hiSetProgressText to update the text or hiSetProgressAndText to update both the step and the text.

Arguments

g_dboxID	The ID of the progress dialog box.
x_step	The step to which you want to set the progress bar. If the number you specify is greater than the total number of steps in the progress bar, it is set to the highest step.

Value Returned

t	The progress bar was set to the step you specified.
nil	There was an error.

Related Topics

Progress Dialog Box Functions

hiDisplayProgressBox

hiIsProgressBoxCancelled

hiSetProgressText

hiSetProgressTotalSteps

Return to top