.. highlightlang:: us

.. _updf_rename_element:

updf_rename_element
===================

.. index:: updf_rename_element

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

:ref:`updf_rename_element` changes the name of a stream or storage.

.. function::  ret = updf_rename_element(stg, oldname, newname)

.. us.return

**Return Value**

*ret* is TRUE (1) or an error object (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:: oldname

   *oldname* is the old name of a storage or stream.

.. uparam:: newname

   *newname*  is the new name of a storage or stream.

.. us.example

**Example**

.. include:: ../include/test_updf_rename_element.ic

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

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

:sub:`id-1289254`