.. highlightlang:: us

.. index:: AppProgressCreate

.. _appprogresscreate:

AppProgressCreate
=================

.. us.tag  AppProgressCreate NOTREADYENGLISH App Toolbar New300 Changed5144 Changed5401

:ref:`AppProgressCreate` creates a process control in the status bar or a 
dialog box with a progress control and a Cancel button.

.. function::  bool = AppProgressCreate()
               bool = AppProgressCreate(nUpper)
               bool = AppProgressCreate(nUpper, nOption)
               bool = AppProgressCreate(nLower, nUpper, nStep, nOption)
               bool = AppProgressCreate(nLower, nUpper, nStep, nOption, ssTitle)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1);
otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: nLower

   Default value is 0.

.. uparam:: nUpper

   Default value is 100.

.. uparam:: nStep

   Default value is 1.

.. uparam:: nOption

   0 oder 1: Progress control in the status bar. 2: Creates a progress dialog 
   box. Defaultwert ist 0.

.. uparam:: ssTitle

   Titel for the progress dialog box, if *nOption* is set to 2. Defaultwert
   value is "Progress".

.. us.comment

**Comment**

Beginning with UniPlot R2015.8 calls of :ref:`AppProgressDialog` and
:ref:`AppProgressCreate` can be nested. See :ref:`AppProgressDialog`.

.. us.example

**Example**

::

   def TestAppProgressCreate()
   {
       AppProgressCreate(67)
       for (i in 1:67) {
           AppProgressStepIt()
           AppSleep(50); // Simulate some work
       }
       AppProgressDestroy()
   }

   TestAppProgressCreate()

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2015.8
     - Progress bar with stack support.
   * - R2012.1 (5.40.1)
     - *bSmooth* replaced by *nOption* and new parameter *ssTitle*.
   * - 5.14.4
     - Call with one parameter changed: Instead of bSmooth, nUpper is set.

.. seealso::
   :ref:`overview-application-object`,
   :ref:`AppProgressStepIt`,
   :ref:`AppProgressDialog`,
   :ref:`AppProgressDestroy`,
   :ref:`ShowWaitCursor`,
   :ref:`AppSetStatusBarText`

:sub:`id-972059`