.. highlightlang:: us

.. index:: text_file_write

.. _text_file_write:

text_file_write
===============

.. us.tag  text_file_write GERMAN FILE_MISC unicode New500 Changed5501

:ref:`text_file_write` schreibt einen Text in eine Datei in ANSI- oder
Unicode-Kodierung.

.. function::  bool = text_file_write(ssFilename, ssText)
               bool = text_file_write(ssFilename, ssText, ssEncoding)
               bool = text_file_write(ssFilename, ssText, ssEncoding, ssNewline)

.. us.return

**Returnwert**

*bool* ist TRUE (1) wenn die Datei geschrieben werden konnte und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: ssFilename

   *ssFilename* ist der komplette Name (mit Pfad) der Textdatei. Falls die Datei
   bereits existiert, wird sie überschrieben.

.. uparam:: ssText

   *ssText* ist der Text.

.. uparam:: ssEncoding

   *ssEncoding* ist eine der folgenden Zeichenketten:

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

      * - Wert
        - Bedeutung
      * - ansi
        - Default Wert
      * - utf8bom
        - UTF-8 with BOM (Byte Order Mark).
      * - utf8
        - UTF-8 without BOM.
      * - utf16le
        - UTF-16 little endian without BOM.
      * - utf16lebom
        - UTF-16 little endian with BOM.
      * - utf16
        - UTF-16 without BOM.
      * - utf16bom
        - UTF-16 with BOM.

   Bei den Werten wird Groß-/Kleinschreibung nicht unterschieden und
   Minus-Zeichen werden rausgefiltert, ``UTF-16-LE`` ist also auch gültig.

.. uparam:: ssNewline

   *ssNewline* ist einer der folgenden Werte:

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

      * - Wert
        - Bedeutung
      * - "default"
        - Default Wert, entspricht "crlf"
      * - "crlf"
        - ``\x0d \x0a``
      * - "cr"
        - ``\x0d``
      * - "lf"
        - ``\x0a``

.. us.example

**Beispiel**

::

   ssText = "[[This is
   a text]]";
   text_file_write("c:/test.txt", ssText, "ansi", "default")

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2013.1
     - Bei dem Parameter *ssEncoding* dürfen ``-``-Zeichen im Wert stehen, z. B.
       ``utf-8``.
   * - 5.0.0
     - Neu.

.. seealso::
   :ref:`uberblick-binar--und-text-dateien`,
   :ref:`text_file_read`

:sub:`id-847459`