.. highlightlang:: us

.. index:: DocIsReadOnly

.. _docisreadonly:

DocIsReadOnly
=============

.. us.tag  DocIsReadOnly DocGet New400

:ref:`DocIsReadOnly` checks if the read-only flag is set.

.. function::  bReadOnly = DocIsReadOnly(hDoc)

.. us.return

**Return Value**

*bReadOnly* is TRUE (1) if the read-only flag is set.

.. us.params

**Parameters**

.. uparam:: hDoc

   Identifies the document.

.. seealso::
   :ref:`overview-documents`,
   :ref:`DocSetReadOnly`

:sub:`id-1296228`