prevnext   » Startseite » Haupt-Referenz » Funktions-Referenz » m$store()

m$store()

Ein Element in eine Map einfügen oder ein bestehendes Element überschreiben.

Syntax:

bool m$store ( map_var, string:key, value )

Parameter:

map_var Die Funktion m$store erwartetet (wie alle m$*() Funktionen) als ersten Parameter eine Referenz auf eine (ggf. indizierte) Variable. Diese Variable wird identisch zu map() zwangsweise in eine Map gewandelt, um anschließend modifiziert zu werden.

Der Inhalt der Variable map_var wird nicht auf den Stack kopiert. Stattdessen wird direkt und damit effizient auf den Inhalt der Variable zugegriffen.

string:key Der Schlüssel, unter dem value in die Map eingetragen werden soll. Der Schlüssel wird zwangsweise mittels string() in eine Zeichenkette gewandelt.
value Ein beliebiger Ausdruck, der in die Map eingetragen werden soll.

Beschreibung:

Der Wert value wird in die Map map_var unter dem Schlüssel key eingetragen. Ein bereits existierendes Element wird dabei überschrieben.

Funktionsergebnis:   BOOL

Als Funktionsergebnis wird genau dann true geliefert, wenn kein Element mit dem Schlüssel key existierte und daher ein neues Element in die Map eingetragen wurde.

Anderenfall wurde ein bestehndes Element überschrieben.

Siehe auch:
 m$insert()   m$replace()   m$remove()   m$storeMap() 

Weitere ähnliche Funktionen:

Maps, Einfügen und Löschen
Funktion Kurzinfo
m$insert() Ein Element mit einem nicht existierenden Schlüssel in eine Map einfügen.
m$insertMap()
m$remove()
m$removeMap()
m$replace() Ein existierendes Element in einer Map überschreiben.
m$replaceMap()
m$store() Ein Element in eine Map einfügen oder ein bestehendes Element überschreiben.
m$storeMap()