.. highlightlang:: us

.. index:: updf_open_stream

.. _updf_open_stream:

updf_open_stream
================

.. us.tag  updf_open_stream NOTREADYENGLISH updf updf-stor updf-stream New560

:ref:`updf_open_stream` opens an existing stream in a updf file.

.. function::  file = updf_open_stream(stg, name)
               file = updf_open_stream(stg, name, mode)

.. us.return

**Return Value**

*file* is the pointer to the stream or 0 if the stream cannot be opened.

.. us.params

**Parameters**

.. uparam:: stg

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

.. uparam:: name

   *name* is the stream name.

.. uparam:: mode

   *mode* must be 0. Other flags are not defined yet.

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

.. seealso::
   :ref:`overview-updf-files`,
   :ref:`updf_file_close`

:sub:`id-151703`