.. highlightlang:: us

.. index:: xml_esc

.. _xml_esc:

xml_esc
=======

.. us.tag xml_esc NOTREADYENGLISH XML New5200 Changed5500

:ref:`xml_esc` escapes special XML characters.

.. function:: ssOut = xml_esc(ssIn)

.. us.return

**Return Value**

*ssOut* escaped string.

.. us.params

**Parameters**

.. uparam:: ssIn

   *ssIn* unescaped string.

.. us.comment

**Comment**

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

   * - ssIn
     - ssOut
   * - &
     - &
   * - <
     - &lt;
   * - >
     - &gt;
   * - '
     - &apos;
   * - "
     - &quote;
   * - 0x01 .. 0x08, 0x0e, 0x0f, 0x11 .. 0x1f
     - removed

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013
     - Documented.
   * - R2010
     - New.

.. seealso::
   :ref:`Overview-XML`,
   :ref:`text_file_read`,
   :ref:`xml_save_node`

:sub:`id-1002398`