.. highlightlang:: us

.. index:: xml_save_node

.. _xml_save_node:

xml_save_node
=============

.. us.tag xml_save_node GERMAN XML New5200 Changed5505

:ref:`xml_save_node` speichert ein speziell aufgebautes UniScript-Objekt als
XML-Datei.

.. function:: bool = xml_save_node(oXML, ssFileName)
              bool = xml_save_node(oXML, ssFileName, nFormatted)
              ssXML = xml_save_node(oXML, "", nFormatted)

.. us.return

**Returnwert**

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

Falls für *ssFileName* ein leerer String übergeben wird, wird *oXML* nicht in 
eine Datei geschrieben, sondern als String *ssXML* zurück geliefert.

.. us.params

**Parameter**

.. uparam:: oXML

   *oXML* ist ein speziell aufgebautes UniScript-Objekt (siehe Kommentar).

.. uparam:: ssFileName

   *ssFileName* ist der Name der Datei.

.. uparam:: nFormatted

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

      * - Wert
        - Beschreibung
      * - 0
        - Ausgabe ohne Zeilenumbrüche. Es werden nur in Textelementen
          Zeilenumbrüche ausgegeben. (Default)
      * - 1
        - Zeilenumbrüche und Einrückung mit zwei Leerzeichen.

.. us.comment

**Kommentar**

Das Objekt *oXML* muss folgenden Aufbau haben::

  oXML = [.
     [1] = "text node"
     [2] = oXML_other
     [N] = ...
     attr = [. name=ssValue, ...]
     name = "element-name"
  ]

.. us.example

**Beispiel**

.. include:: ../include/test_xml_save_node.ic

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2013.5
     - Falls für *ssFileName* ein leerer String übergeben wird, wird *oXML* nicht
       in eine Datei geschrieben, sondern als String *ssXML* zurück geliefert.
   * - 5.20
     - Neu.

.. seealso::
   :ref:`uberblick-XML`,
   :ref:`text_file_read`,
   :ref:`xml_parse_string`,
   :ref:`xml_esc`

:sub:`id-1241474`