.. highlightlang:: us

.. index:: UserBar_Add

.. _userbar_add:

UserBar_Add
===========

.. us.tag  UserBar_Add GERMAN Toolbar New300

:ref:`UserBar_Add` fügt ein Kommando in die Benutzerschalterleiste ein. Das
Kommando muss mit der Funktion :ref:`RegisterCommand` vorher registriert worden
sein.

.. function::  bool = UserBar_Add(ssFunctionName)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war. und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: ssFunctionName

   *ssFunctionName* ist der Name der Funktion, die aufgerufen werden soll, wenn
   der Benutzer den entsprechenden Schalter aus der Benutzerschalterleiste drückt.
   Der Name der Funktion wird an :ref:`UserBar_Add` ohne die runden Klammern übergeben
   (siehe Beispiel). Die zu registrierende Funktion darf keine Parameterliste
   enthalten. Die Groß- und Kleinschreibung des Funktionsnames muss beachtet werden.

.. us.example

**Beispiel**

Das folgende Beispiel zeigt, wie man eine einfache Funktion für die
Benutzerschalterleiste definieren kann und die Funktion registriert.

::

   RegisterCommand("2D-Datensatz", "MyScaleFunc", "2D-Meine Skalierung");
   UserBar_Add("MyScaleFunc");
   def MyScaleFunc()
   {
      hvHandle = GetActiveXYHandles(); // defined in ic_util.ic
      if (hvHandle[1] == 0) {
         return;
      }
      rmXY = XYGetData(hvHandle[4]);
      rmXY[;2] = rmXY[;2] * 1.034 + 0.123;
      XYSetData(hvHandle[4], rmXY[;1], rmXY[;2]);
   }

.. seealso::
   :ref:`uberblick-programmierung`,
   :ref:`extrasbenutzerschalterleiste-einrichten`,
   :ref:`RegisterCommand`

:sub:`id-1419623`