StopProgress(handle)
Description
Section titled “Description”The StopProgress Lua function removes a progress bar. A handle input argument defines which progress bar it removes. The progress bar must exist before it can be removed. Progress bars are created using the StartProgress function.
See the ProgressBar topic for more info regarding progress bars and links to other related functions.
Arguments
Section titled “Arguments”- Handle:
The handle for the progress bar to be stopped.
Return
Section titled “Return”This function does not return anything.
Example
Section titled “Example”This example stops the progress bar created using the example in the StartProgress topic (link above):
| Copy CodeLua |
| ``` |
| return function() |
-- Stops and closes the progress bar with the matching handleStopProgress(progressHandle)end