progressbar_start_job
progressbar_start_job(jobLabel, taskLabel[, nTasks=0[, allowCancel=1[, delay=0]]])
Initializes a new job to be reported in the progress bar dialog box. If the progress bar dialog boxis already being shown, the new job replaces any existing job. If the dialog box is not currently visible this function raises it, after a delay if delay has a non-zero value.
• jobLabel — a short description of the overall job. This will be shown in bold text above the progress bar in the dialog box.
• taskLabel — a short description of the initial task. This will be shown in regular text below the progress bar in the dialog box.
• nTasks — the total number of steps required by the job. If set to 0 (the default) or a negative value, the progress bar will be shown in indeterminate, or waiting, mode.
• allowCancel — whether to enable the Cancel button on the dialog box. The default is 1 (enable).
Operations using the progress bar API that do not regularly check the result of
progressbar_cancelled() should disable the
Cancel button.
• delay — the number of seconds to wait before showing the progress bar dialog box.
Some jobs may execute quickly or slowly depending on various features, and it may not be desirable to display the progress bar dialog immediately. When the dialog box is shown after the delay, its state will reflect the most recent call to
progressbar_update().
It is important that scripts that use this function also call progressbar_close() before exiting, since the progress bar dialog box cannot be dismissed by the user..
