.. highlightlang:: us

.. index:: EdSetReadOnly

.. _edsetreadonly:

EdSetReadOnly
=============

.. us.tag  EdSetReadOnly EdSet New400

:ref:`EdSetReadOnly` sets the read-only flag.

.. function::  bool = EdSetReadOnly(hEdit, bReadOnly)

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

   A Boolean that sets whether the document is read-only. Possible values are: 
   TRUE (1): Makes the document read-only in UniPlot. FALSE (0):  Makes the
   document read/write in UniPlot, but does not change its status on disk.
   For example, if the document is read-only on disk, it remains read-only. 

.. seealso::
   :ref:`overview-editors`,
   :ref:`EdIsReadOnly`

:sub:`id-169806`