hiShowProgressBar

hiShowProgressBar(
w_windowID
[ x_totalSteps ]
[ x_delay ]
[ t_label ]

)
=> t / nil

Desecription

Displays a progress bar in the status bar of a window, typically in the bottom-right corner. The progress bar displays the progress of a command.

This function sets the total number of steps in the progress bar as well as the delay before the progress bar appears on the window. To set the current progress, use hiSetProgressBar.

Arguments

w_windowID	The window to which you want to add the progress bar.
x_totalSteps	The total number of steps on the progress bar.
x_delay	The time delay, in milliseconds, before the progress box appears.
t_label	The progress bar label, that is, the text that is displayed on the left of the progress bar. You can also use hiSetProgressLabel to set the label.

Values Returned

t	The progress bar was displayed.
nil	There was an error.

Example

hiShowProgressBar(window(3) 200 0)
hiSetProgressBar(window(3) 50)

Related Topics

Progress Dialog Box Functions

hiDisplayProgressBox

hiIsProgressBoxCancelled

hiSetProgress

hiSetProgressText

hiSetProgressLabel

Return to top