.. highlightlang:: us

.. _diary:

diary
=====

.. index:: diary

.. us.tag  diary GERMAN Changed520

:ref:`diary` öffnet bzw. schließt eine Datei in der alle Ein- bzw. Ausgaben des
Kommando-Fensters aufgezeichnet werden.

.. function::  bool = diary()
    bool = diary(bUTF8)
    bool = diary(ssFileName)
    bool = diary(ssFileName, bUTF8)

.. us.return

**Returnwert**

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

.. us.params

**Parameter**

.. uparam:: ssFileName

   *ssFileName* ist der vollständige Name der Datei in der die Ein/Ausgaben des
   Kommando-Fensters geschrieben werden sollen.  Falls kein Dateiname angegeben
   wird, wird der Standardname ``"diary"`` verwendet. Die Datei wird in das 
   UniPlot-Benutzer-Verzeichnis geschrieben.

.. uparam:: bUTF8

   Wenn *bUTF8* TRUE (1) ist, werden Zeichenketten in der Unicode UTF-8 Kodierung
   geschrieben.

.. us.comment

**Kommentar**

Falls die Diary-Datei bei Aufruf der Datei geöffnet ist, wird sie durch den 
diary()-Funktionsaufruf geschlossen.

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.2.0
     - Unicode-Fehler entfernt und neuen Parameter *bUTF8*  eingeführt.

.. seealso::
   :ref:`uberblick-programmierung`

:sub:`id-478333`