.. highlightlang:: us

.. index:: EdSetEncoding

.. _EdSetEncoding:

EdSetEncoding
=============

.. us.tag  EdSetEncoding ENGLISH EdSet New5505

:ref:`EdSetEncoding` sets the output coding of an editor.

.. function::  bool = EdSetEncoding(hEdit, ssEncoding, ssNewline)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hEdit

   Identifies the editor.

.. uparam:: ssEncoding

   *ssEncoding* is one of the following strings:

   .. 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.

   The values are case insensitive and minus characters are ignored.
   ``UTF-16-LE`` is a valid value.

.. uparam:: ssNewline

   *ssNewline* is one of the following strings:

   .. 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
   * - R2013.5
     - New.

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

:sub:`id-733728`