.. highlightlang:: us

.. index:: MapLookup

.. _maplookup:

MapLookup
=========

.. us.tag  MapLookup GERMAN Map_Get Changed420 Changed570

:ref:`MapLookup` verwendet einen Hashing Algorithmus um ein Element im Map-Objekt
zu finden.

.. function::  data = MapLookup(hMap, ssKey)
    data = MapLookup(hMap, ssKey, default_value)

.. us.return

**Returnwert**

*data*  ist eine reelle-, komplexe- oder String-Matrix. Im Fehlerfall liefert
die Funktion den Wert 0.

.. us.params

**Parameter**

.. uparam:: hMap

   *hMap* ist die Zugriffsnummer des mit :ref:`MapCreate` erzeugten Map-Objekts.

.. uparam:: ssKey

   *ssKey* ist eine skalare Zeichenkette, mit der auf ein Element des Map-Objekts
   zugegriffen werden kann.

.. uparam:: default_value

   Die Funktion liefert den Wert *default_value*, falls der Schlüssel *ssKey*
   im Map-Objekt nicht existiert. *default_value* kann eine reelle-, komplexe- 
   oder String-Matrix sein.

.. us.comment

**Kommentar**

Um zu prüfen, ob der zurückgelieferte Wert gültig ist, kann die Funktion
:ref:`ObjGetOk` aufgerufen werden. Wenn z. B. der Schlüssel *ssKey* in der Tabelle
nicht existiert, liefert die Funktion :ref:`ObjGetOk` den Wert FALSE (0).

.. us.example

**Beispiel**

::

   hMap = MapCreate();
   MapSetAt(hMap, "Test1", [1,2,3,4,5,6]);
   MapSetAt(hMap, "Test2", [2,5,7,6,3,1,6,7,8]);
   MapSetAt(hMap, "Header1", ["1,5l", "4 Valves"]);
   if (MapKeyExists(hMap, "Test2") {
       rmStr = MapLookup(hMap, "Test2");
   } else 
       // set to default:
       rmStr = [2,5,7,6,3,1,6,7,8];
   }
   // or
   rmStr = MapLookup(hMap, "Test1", [2,5,7,6,3,1,6,7,8]);

.. us.history

**History**

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

   * - Version
     - Beschreibung
   * - 5.7.0
     - Neuer Parameter *default_value* zugefügt.
   * - 4.2.0
     - Die Funktion liefert auch String-Daten mit 0-Zeichen.

.. seealso::
   :ref:`uberblick-map`,
   :ref:`MapCreate`,
   :ref:`MapSetAt`,
   :ref:`MapKeyExists`

:sub:`id-2108427`