.. highlightlang:: us

.. _diary:

diary
=====

.. index:: diary

.. us.tag  diary ENGLISH Changed520

:ref:`diary` opens and closes a file in which all input and output of the command
window will be written.

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

.. us.return

**Return Value**

*bool* is TRUE (1), if the function was successful and FALSE (0) if an error
occurred.

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* is the complete file name for input and output. If this parameter
   is not specified, the default name ``"diary"`` is used. The file will be written
   to the UniPlot user directory.

.. uparam:: bUTF8

   If *bUTF8* is TRUE (1) the strings will be written as Unicode UTF-8.

.. us.comment

**Comment**

If the diary file is opened with a :ref:`diary` function call, it will be closed by
the next *diary* function call.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.2.0
     - Unicode error fixed an new parameter *bUTF8*  added.

.. seealso::
   :ref:`overview-programming`

:sub:`id-478333`