Dokumentation
IPS_GetVariableIDByName
int IPS_GetVariableIDByName (string $VariablenName, int $ÜbergeordneteID)
Parameterliste
VariablenName | Zu suchender VariablenName |
ÜbergeordneteID | Objekt, in deren direkten Unterobjekten gesucht werden soll |
Rückgabewert
ID der gefundenen Variable, sonst FALSE
Beschreibung
Die Funktion versucht die ID der Variablen mit dem Namen VariablenName, deren übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID der ersten gefundenen Variablen verwendet, deren Name mit VariablenName übereinstimmt. Falls eine solche Variable gefunden wurde, wird deren ID zurückgemeldet, andernfalls FALSE.
Da hier im Gegensatz zu IPS_GetVariableID ein zusätzliches Kriterium (ÜbergeordneteID) bei der Suche verwendet wird, ist die Wahrscheinlichkeit die richtige ID zu finden erheblich größer. Trotzdem gilt:
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. Es muss der @ Operator genutzt werden, falls diese Meldung unterdrückt werden soll. Die genaue Funktionsweise dieses Operators kann dem PHP Handbuch entnommen werden.
Beispiel
$VariablenID = @IPS_GetVariableIDByName("Regenmenge", $ÜbergeordneteID);
if ($VariablenID === false)
echo "Variable nicht gefunden!";
else
echo "Die Variablen-ID lautet: ". $VariablenID;