DestroyProgressBar()

Summary

Destroys a progress bar, indicating completion of an operation.

 

Syntax

DestroyProgressBar()

 

Notes

• DestroyProgressBar() closes the most recently created progress bar.

• DestroyProgressBar() can be called even when the progress window is disabled.

Example

SetProgressWindow("Status", 1)     // Allow only a single progress bar

CreateProgressBar("Calculating...", "True")

for i = 1 to 100 do

     stat = UpdateProgressBar("Step Number " + String(i), i)

     if stat = "True" then do

          ShowMessage("You Quit!")

          goto quit_loop

          end

     x = x + i * i          // The meat of this loop

     end

quit_loop:

DestroyProgressBar()

ResetProgressWindow()    // Return to previous maximum number of progress bars

 

Error Codes

Error Type	Meaning
NotFound	There was no progress bar to destroy

 

See Also

Function	Summary
CreateProgressBar()	Creates a new progress bar
ResetProgressWindow()	Resets the title and the maximum number of progress bars that can be created in the progress window to the number prior to the last call to SetProgressWindow()
SetProgressWindow()	Sets the title and the maximum number of progress bars that can be created in the progress window
UpdateProgressBar()	Updates a progress bar in the progress window