.. highlightlang:: us

.. index:: updf_file_close

.. _updf_file_close:

updf_file_close
===============

.. us.tag  updf_file_close NOTREADYENGLISH updf updf-stream New560

:ref:`updf_file_close` closes a updf stream.

.. function::  bool = updf_file_close(file)

.. us.return

**Return Value**

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

.. us.params

**Parameters**

.. uparam:: file

   *file* is the pointer to a stream.

.. us.example

**Example**

See :ref:`updf_create_stream`.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

.. seealso::
   :ref:`overview-updf-files`,
   :ref:`updf_commit`,
   :ref:`updf_open_stream`,
   :ref:`updf_create_stream`

:sub:`id-110303`