.. highlightlang:: us

.. _updf_gen:

updf_gen
========

.. index:: updf_gen

.. us.tag  updf_gen NOTREADYENGLISH updf updf-misc New560

:ref:`updf_gen` copies the all files of directory an its subdirectories
into an updf file.

.. function::  bool = updf_gen(stg, ssDir)

.. us.return

**Return Value**

*bool*.

.. us.params

**Parameters**

.. uparam:: stg

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

.. uparam:: ssDir

   *ssDir* is the directory name.

.. us.comment

**Comment**

All files will be copied into storage and streams recursively.

.. us.example

**Example**

.. include:: ../include/test_updf_gen.ic

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

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

:sub:`id-1579932`