CreateProgressBar()

Summary

Creates a new progress bar that reports the progress of an operation.

Syntax

CreateProgressBar(string activity, boolean cancel_button [, array substition:values] )

Notes

• If the progress window is enabled but not visible, calling CreateProgressBar() displays the window.

• CreateProgressBar() can be called without signaling an error:

• • when the progress window is disabled

  • when the progress bar contains the number of nested progress bars allowed in SetProgressWindow()

• The cancel_button argument is used only when the first progress bar is created in the progress window. Otherwise, it is ignored.

• If the type of substitution values do not correspond to the formatting placeholders, the activity text will be blank.

• 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()

See Also