.. highlightlang:: us

.. _updf_enum_begin:

updf_enum_begin
===============

.. index:: updf_enum_begin

.. us.tag  updf_enum_begin NOTREADYENGLISH updf updf-enum New560

:ref:`updf_enum_begin` can be used with :ref:`updf_enum_next` to iterate over all
streams and storages of a storage object.

.. function::  enum = updf_enum_begin(stg)

.. us.return

**Return Value**

*enum*.

.. us.params

**Parameters**

.. uparam:: stg

   *stg*.

.. us.example

**Example**

.. include:: ../include/test_updf_enum_begin.ic

.. us.history

**History**

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

   * - Version
     - Description
   * - 5.6.0
     - New

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

:sub:`id-410456`