.. highlightlang:: us

.. index:: updf_copy_to

.. _updf_copy_to:

updf_copy_to
============

.. us.tag  updf_copy_to NOTREADYENGLISH updf updf-stor New560

:ref:`updf_copy_to` copies a storages and all containing streams, storages and 
properties recursively into another storage.

.. function::  ret = updf_copy_to(stg, stgDest)

.. us.return

**Return Value**

*ret* is either the number 1 or an error object, if an error occurred. (see
:ref:`error_create`).

.. us.params

**Parameters**

.. uparam:: stg

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

.. uparam:: stgDest

   *stgDest* is the destination storage located in the same file or a different
   file.

.. us.example

**Example**

.. include:: ../include/test_updf_copy_to.ic

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

.. seealso::
   :ref:`overview-updf-files`,
   :ref:`updf_file_copy_to`,
   :ref:`updf_prop_copy_to`

:sub:`id-1380051`