.. highlightlang:: us

.. index:: units_get_preferred_unit

.. _units_get_preferred_unit:

units_get_preferred_unit
========================

.. us.tag units_get_preferred_unit NOTREADYGERMAN units New5511

:ref:`units_get_preferred_unit` liefert die bevorzugte Einheit.

.. function:: ssPrefUnit = units_get_preferred_unit(oUnit, ssUnit)
              ssPrefUnit = units_get_preferred_unit(oUnit, ssUnit, ssChannelName)

.. us.return

**Returnwert**

*ssPrefUnit* ist die bevorzugte Einheit. Falls *ssChannelName* angegeben ist, 
wird die Einheit zunächst in der Channel-Seite der units-Tabelle gesucht (siehe
:ref:`overview-units`). Falls sie dort nicht vorhanden ist, wird die Einheit 
aus der "Preferred"-Spalte der units-Tabelle verwendet.

.. us.params

**Parameter**

.. uparam:: oUnit

   Ist das von :ref:`units` gelieferte Einheiten-Umrechner-Objekt.

.. uparam:: ssUnit

   *ssUnit* ist eine beliebige Einheit aus der Einheitentabelle (siehe
   :ref:`overview-units`). Kann ein leerer String sein, falls der Parameter
   *ssChannelName* angegeben wird.

.. uparam:: ssChannelName

   *ssChannelName* ist ein Kanalname für den die bevorzugte Einheit gesucht
   werden soll.

.. us.comment

**Kommentar**

Die Funktion kann auch in der Form ``oUnit.preferred(ssUnit, ssChannelName)``
aufgerufen werden.

.. us.example

**Beispiel**

::

   o = units()
   units_get_preferred_unit(o, "PS")
   kW

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2013.11
     - Neu.

.. seealso::
   :ref:`overview-units`,
   :ref:`units`

:sub:`id-759758`