.. highlightlang:: us

.. _objgetfirst:

ObjGetFirst
===========

.. index:: ObjGetFirst

.. us.tag  ObjGetFirst GERMAN

:ref:`ObjGetFirst` wird in Verbindung mit
:ref:`ObjGetNext` dazu verwendet, über alle Objekte zu iterieren.

.. function::  handleOut = ObjGetFirst()
    handleOut = ObjGetFirst(handle)
    handleOut = ObjGetFirst(ssClass)
    handleOut = ObjGetFirst(handle, ssClass)

.. us.return

**Returnwert**

*handleOut* ist eine Zugriffsnummer.

.. us.params

**Parameter**

.. uparam:: handle

   *handle* ist eine Zugriffsnummer.

.. uparam:: ssClass

   *ssClass* ist ein Klassenname.

.. us.comment

**Kommentar**

Wird die Funktion ohne Parameter aufgerufen, gibt sie die
Zugriffsnummer des ersten Objekts zurück.

Wird die Funktion mit einem Klassennamen - z. B. ``"OBJ_DOCUMENT"``,
``"OBJ_LAYER"``, ``"OBJ_TEXT"`` - aufgerufen, gibt sie die Zugriffsnummer des
ersten Objekts der angegebenen Klasse zurück.

Wird die Funktion mit einer Zugriffsnummer aufgerufen, gibt sie das
erste Objekt zurück, das in dem Objekt mit der angegebenen
Zugriffsnummer enthalten sind (Objekte vom Typ ``OBJ_DOCUMENT``  und
``OBJ_LAYER`` können Objekte enthalten).

Wird die Funktion mit einer Zugriffsnummer und einem Klassennamen
aufgerufen, gibt sie das erste Objekt der angegebenen Klasse zurück,
die das Objekt mit der angegebenen Zugriffsnummer, enthält. Beispiel:
Ist 17 die Zugriffsnummer eines Diagramms (``OBJ_LAYER``), dann liefert
``ObjGetFirst(17, "OBJ_TEXT")`` das erste Text-Objekt des Diagramms oder
0, wenn das Diagramm keine Text-Objekte enthält.

.. seealso::
   :ref:`uberblick-objekte`,
   :ref:`ObjCreate`,
   :ref:`ObjGetNext`,
   :ref:`ObjGetClass`,
   :ref:`ObjGet`

:sub:`id-1594898`