hiIsProgressBoxCancelled

hiIsProgressBoxCancelled(
g_dboxID
)
=> t / nil

Description

Checks whether a progress box is canceled. A progress box is considered canceled if it is canceled with the Cancel button, canceled with the hiCancelProgressBox function, closed from the window manager, or automatically closed when the progress bar reaches 100% (if it was created with the ?autoClose argument set to t).

Argument

g_dboxID

The ID of the progress dialog box.

Value Returned

t	The progress box has been canceled.
nil	The progress box has not been canceled.

Related Topics

Progress Dialog Box Functions

hiDisplayProgressBox

hiIsProgressBoxCancelled

hiGetProgress

hiGetProgressTotalSteps

hiSetProgress

hiSetProgressText

hiSetProgressTotalSteps

Return to top