.. highlightlang:: us

.. index:: updf_get_cmode

.. _updf_get_cmode:

updf_get_cmode
==============

.. us.tag updf_get_cmode NOTREADYENGLISH updf updf-stor New5500

:ref:`updf_get_cmode` return the mode the UPDF file has been created with.

.. function:: cmode = updf_get_cmode(stg)

.. us.return

**Return Value**

*cmode* is 0 or a combination of the two flags ``UPDF_REPACKING`` and
``UPDF_ZLIB_COMPRESSION``.

.. us.params

**Parameters**

.. uparam:: stg

   *stg* is a storage object (see :ref:`updf_create_file`, :ref:`updf_open_file`,
   :ref:`updf_create_storage`).

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013 (5.50)
     - New.

.. seealso::
   :ref:`Overview-UPDF-Files`,
   :ref:`updf_create_file`

:sub:`id-349246`