.. highlightlang:: us

.. index:: log_error
.. index:: log_trace
.. index:: log_debug
.. index:: log_info
.. index:: log_warning
.. index:: log_fatal

.. _log_warning:
.. _log_info:
.. _log_error:

log_error
=========

.. us.tag  log_error NOTREADYENGLISH New500 Programming.Logging

:ref:`log_error` writes a log message.

.. function::  bool = log_trace(ssLogger, ssSource, ssMessage, ...)
    bool = log_debug(ssLogger, ssSource, ssMessage, ...)
    bool = log_info(ssLogger, ssSource, ssMessage, ...)
    bool = log_warning(ssLogger, ssSource, ssMessage, ...)
    bool = log_error(ssLogger, ssSource, ssMessage, ...)
    bool = log_fatal(ssLogger, ssSource, ssMessage, ...)

.. us.return

**Return Value**

*bool* is TRUE (1) if the function was successful and otherwise FALSE (0).

.. us.params

**Parameters**

.. uparam:: ssLogger

   *ssLogger* is a logger name. If an empty string is specified ("") the 
   "uniscript" logger is used.

.. uparam:: ssSource

   *ssSource* is a string with the log source. An empty string ("") is valid.

.. uparam:: ssMessage

   *ssMessage* is the logging message. The string can contain embedded 
   format characters. The parameters following the *ssMessage* 
   contain the optional arguments. See :ref:`sprintf`. 

.. us.example

**Example**

::

   n = 4;
   log_trace("uniscript", "", "Number of Points: %d", n);

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.0.0
     - New

.. seealso::
   :ref:`overview-logging`,
   :ref:`log_get_logger_names`

:sub:`id-1148088`