.. highlightlang:: us

.. index:: DocSetReadOnly

.. _docsetreadonly:

DocSetReadOnly
==============

.. us.tag  DocSetReadOnly NOTREADYENGLISH DocSet New400

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

.. function::  bool = DocSetReadOnly(hDoc, bReadOnly)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: hDoc

   Identifies the document.

.. 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-documents`,
   :ref:`DocIsReadOnly`

:sub:`id-750700`