.. highlightlang:: us

.. index:: EdGetEncoding

.. _EdGetEncoding:

EdGetEncoding
=============

.. us.tag  EdGetEncoding ENGLISH EdGet New5806

:ref:`EdGetEncoding` gets the output encoding of an editor.

.. function::  ssEncoding = EdGetEncoding(hEdit)

.. us.return

**Return Value**

*ssEncoding* is a string containing the encoding and the line separator
separated by a space, eg. ``"utf8 crlf"``.

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

   * - Value
     - Meaning
   * - ansi
     - default value
   * - utf8bom
     - UTF-8 with BOM (Byte Order Mark).
   * - utf8
     - UTF-8 without BOM.
   * - utf16le
     - UTF-16 little endian without BOM.
   * - utf16lebom
     - UTF-16 little endian with BOM.
   * - utf16
     - UTF-16 without BOM.
   * - utf16bom
     - UTF-16 with BOM.

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

   * - Value
     - Meaning
   * - "default"
     - Default value ("crlf")
   * - "crlf"
     - ``\x0d \x0a``
   * - "cr"
     - ``\x0d``
   * - "lf"
     - ``\x0a``

.. us.history

**History**

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

   * - Version
     - Description
   * - R2016.6
     - New.

.. seealso::
   :ref:`overview-editors`,
   :ref:`EdCreate`,
   :ref:`EdSetEncoding`

:sub:`id-753184`