.. highlightlang:: us

.. index:: updf_dump

.. _updf_dump:

updf_dump
=========

.. us.tag  updf_dump GERMAN updf updf-misc New560 Changed5401

:ref:`updf_dump` kopiert die Streams, Storages und Properties der Streams und
Storages einer UPDF-Datei in ein Directory.

.. function::  bool = updf_dump(stg, ssDir)
               bool = updf_dump(stg, ssDir, mode)

.. us.return

**Returnwert**

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

.. us.params

**Parameter**

.. uparam:: stg

   *stg* ist ein Storage-Objekt (siehe :ref:`updf_create_file`,
   :ref:`updf_open_file`, :ref:`updf_create_storage`).

.. uparam:: ssDir

   *ssDir* ist der Name des Verzeichnisses.

.. uparam:: mode

   Ist einer der folgenden Werte:

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

      * - Wert
        - Bedeutung
      * - 0 oder UPDF_FAIL_IF_EXIST
        - Dies ist der Default-Wert, wenn *mode*  nicht angegeben wird. Falls eine Datei oder ein Directory mit dem Namen *ssDir*  existiert schlägt die Funktion fehl.
      * - UPDF_REMOVE_DIRECTORY
        - Das Verzeichniss bzw. die Datei wird zuvor gelöscht.
      * - UPDF_OVERWRITE
        - Verzeichnisse bzw. Dateien werden überschrieben.
      * - UPDF_PROPSONLY
        - Speichert nur die Properties des Storages *stg*.

.. us.comment

**Kommentar**

   Die Properties der Elemente werden in xml-Dateien mit der
   Dateinamenserweiterung :file:`._props_` ausgegeben. Existiert z. B. der Stream
   "Test Stream" wird die Datei "Test Stream._props_" erzeugt.

   .. code-block:: xml

      <?xml version="1.0" encoding="utf-8" ?> 
        <props version="1.0">
          <p n="Units" t="s">
            <v>1/s</v> 
          </p>
          <p n="add_offset" t="f">
            <v>17.2</v> 
          </p>
      </props>

   Die _props_-Dateien enthalten drei XML-Elemente <props/>, <p/> und <v/>. <p/>
   hat vier Attribute n (Name), t (Typ), nr (Anzahl an Zeilen), nc (Anzahl an
   Spalten). Folgende Typen sind vorhanden:

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

      * - Wert
        - Bedeutung
      * - d
        - double
      * - f
        - float
      * - i8
        - int8. 8-Bit Integer mit Vorzeichen.
      * - ui8
        - uint8
      * - i16
        - int16
      * - ui16
        - uint16
      * - i32
        - int32
      * - ui32
        - uint32
      * - i64
        - int64
      * - ui64
        - uint64
      * - s
        - utf-8-String.
      * - b
        - blob (binary large object) base64 kodiert.

   Hinter den Bezeichnungen in der Tabelle kann noch ein "v" für Vektor oder "m"
   für Matrix stehen. Beispiele: "ui64" (unsigned int 64 Bits) "ui64v" (Vektor
   von "ui64") "ui64m" (Matrix von "ui64"). Bei Vektoren muss das Attribut nr
   vorhanden sein. Bei Matrizen muss nr und nc vorhanden sein.

.. us.example

**Beispiel**

.. include:: ../include/test_updf_dump.ic

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - R2012.1 (5.40.1)
     - Neues Flag ``UPDF_PROPSONLY``.
   * - 5.6.0
     - Neu.

.. seealso::
   :ref:`uberblick-updf-dateien`,
   :ref:`updf_gen`

:sub:`id-2043439`