Was können wir verbessern?

Dokumentation

IPS_GetInstanceIDByName

integer IPS_GetInstanceIDByName ( string $InstanzName, integer $ÜbergeordneteID )

Parameterliste

InstanzName Zu suchender InstanzName
ÜbergeordneteID Objekt, in deren direkten Unterobjekten gesucht werden soll

Rückgabewerte

ID der gefundenen Instanz, sonst FALSE

Beschreibung

Die Funktion versucht die ID der Instanz mit dem Namen InstanzName, deren übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID der ersten gefundenen Instanz verwendet, deren Name mit InstanzName übereinstimmt. Falls eine solche Instanz gefunden wurde, wird deren ID zurückgemeldet, andernfalls FALSE.

Vorsicht: Da Namen in IP-Symcon beliebig vergeben werden können, und damit nicht eindeutig sind, kann die Funktion eine falsche ID zurückmelden.

Diese Funktion generiert eine Warnung, sollte der Name nicht gefunden werden. Sollte der Name nicht gefunden werden, muss der @ Operator genutzt, falls diese Meldung unterdrückt werden soll. Die genau Funktionsweise dieses Operators kann dem PHP Handbuch entnommen werden.

Beispiel

$InstanzID = @IPS_GetInstanceIDByName("Regenmenge", $ÜbergeordneteID);
if ($InstanzID === false)
    echo "Instanz nicht gefunden!";
else
    echo "Die Instanz-ID lautet: ". $InstanzID;