.. highlightlang:: us

.. index:: us_set_breakpoint

.. _us_set_breakpoint:

us_set_breakpoint
==================

.. us.tag us_set_breakpoint NOTREADYENGLISH New5800 Programming.Debug

:ref:`us_set_breakpoint` sets a debug break point. If inserted in a script 
file without parameters, the breakpoint will be set in the next 
code line (should not be a comment line). The UniScript path enviroment 
variable  must contain the source file path(``uniscript-path``).

The function is useful to debug functions invoked via the command line.

.. function::  bool = us_set_breakpoint()
               bool = us_set_breakpoint(nLine)
               bool = us_set_breakpoint(ssFile)
               bool = us_set_breakpoint(ssFile, nLine)

.. us.params

**Parameters**

.. uparam:: nLine

   *nLine* is a row number. The row must contain a statement 
   (not a empty or comment line). The given line number must reference 
   a code line in the ic file that will be invoked after :ref:`us_set_breakpoint`
   has been evaluated.

.. uparam:: ssFile

   *ssFile* is the complete file name with the path name. The path will be 
   added to the ``uniscript-path`` enviroment variable.

.. us.comment

**Comment**

:ref:`us_path` will add the path to the ``uniscript-path`` enviroment variable.
If the source code cannot be located the execution of MyTest() will not be
stop at the code line ``a=1;``.

::

   def MyTest()
   {
       us_path("add", "d:/myuniplot/");
       us_set_breakpoint();
       a = 1;   // will stop execution here
   }

.. ------------------------------------------------------------------------------

.. index:: us_get_breakpoints

.. _us_get_breakpoints:

us_get_breakpoints
==================

.. us.tag  us_get_breakpoints NOTREADYENGLISH New5800 Programming.Debug

:ref:`us_get_breakpoints` returns a list of debug break points (String-Array)
of the form ``filename|lineno``.

.. ------------------------------------------------------------------------------

.. index:: us_remove_breakpoints

.. _us_remove_breakpoints:

us_remove_breakpoints
=====================

.. us.tag  us_remove_breakpoints NOTREADYGERMAN New5800 Programming.Debug

:ref:`us_remove_breakpoints` removes all debug break points.

.. function::  bool = us_remove_breakpoints()

.. ------------------------------------------------------------------------------

.. us.history

**History**

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

   * - Version
     - Description
   * - R2016.0
     - Neu.

.. seealso::
   :ref:`overview-programming`,
   :ref:`us_path`

:sub:`id-809299`