The 'ctrlProgressBar' function updates the progress indicator with a step.

  • Prototype: plugin.ctrlProgressBar(sActMsg, nStep, bNonBlocking);
  • Parameters:
    1. sActMsg, a descriptive text to be shown on the status bar.
    2. nStep, a step number to update the progress indicator. If not specified, 1 is assuemd.
    3. bNonBlocking, specifies if or not to allow end-users to abort the process by pressing ESC.
  • Return Value: 0
  • Example:
    plugin.ctrlProgressBar('Insert the file', 1);