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.

• The ProgressBar Class provides methods that simplify the use of progress bars.

Example

 

SetProgressWindow("Status", 1)
CreateProgressBar("Finding %s", "True", {"Neighbors"})
loops = 1000000
for i = 1 to loops do
   stat = UpdateProgressBar("Step Number %i", r2i(i/loops), {i})
   if stat = "True" then do
       ShowMessage("You Quit!")
       goto quit_loop

   end

   // Do some processing here

   //...

   //...

end
quit_loop:
DestroyProgressBar()
ResetProgressWindow()

 

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