.. highlightlang:: us

.. index:: format_number

.. _format_number:

format_number
=============

.. us.tag  format_number GERMAN STR Programming.Convert New5400

:ref:`format_number` wandelt eine Zahl in eine Zeichenkette um. Optional kann das
Dezimaltrennzeichen und ein Tausendertrennzeichen angegeben werden.

.. function::  string = format_number(number)
               string = format_number(number, nDecimals)
               string = format_number(number, nDecimals, ssSeparators)

.. us.return

**Returnwert**

*string* ist eine Stringmatrix.

.. us.params

**Parameter**

.. uparam:: number

   *number* ist eine Zahl oder Zahlen-Matrix.

.. uparam:: nDecimals

   *nDecimals* ist eine ganze Zahl zwischen 0 und 20, die die Anzahl an 
   Nachkommastellen angibt. Default ist 4.

   Falls *nDecimals* negativ ist (-1 bis -20) wird die Zahl im "g"-Format
   ausgegeben (siehe :ref:`sprintf`).

.. uparam:: ssSeparator

   *ssSeparator* ist eine Zeichenkette mit einem oder zwei Zeichen. Das erste
   Zeichen ist der Dezimal-Separator, das zweite Zeichen das
   Tausender-Trennzeichen. Default ist der Punkt "." als Dezimalseparator und
   kein Tausender-Trennzeichen. Dies kann über Registry-Einstellungen
   (``Settings\DecimalSeparator`` und ``Settings\ThousandsSeparator``) geändert
   werden. Default ist ".,".

.. us.example

**Beispiel**

::

   * format_number(1234)
     1234.0000
   * format_number(1234, 2, ".,")
     1,234.00
   * format_number(1234, 2, ",.")
     1.234,00
   * format_number(1234, -6, ".,")
     1,234
   * format_number(1234567, 0, ". ")
     1 234 567

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2012 (5.40.0)
     - Neu.

.. seealso::
   :ref:`uberblick-strings`,
   :ref:`sprintf`,
   :ref:`strtol`,
   :ref:`strtod`

:sub:`id-589650`