Dokumentation
IPS_GetScriptIDByName
int IPS_GetScriptIDByName (string $SkriptName, int $ÜbergeordneteID)
Parameterliste
SkriptName | zu suchender SkriptName |
ÜbergeordneteID | Objekt in deren direkten Unterobjekten gesucht werden soll |
Rückgabewert
ID des gefundenen Skripts, sonst FALSE
Beschreibung
Die Funktion versucht die ID des Skripts mit dem Namen SkriptName, dessen übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID des ersten gefundenen Skripts verwendet, dessen Name mit SkriptName übereinstimmt. Falls ein solches Skript gefunden wurde, wird dessen ID zurückgemeldet, andernfalls FALSE.
Da hier im Gegensatz zu IPS_GetScriptID 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
$SkriptID = @IPS_GetScriptIDByName("Regenerfassung", $ÜbergeordneteID);
if ($SkriptID === false)
echo "Skript nicht gefunden!";
else
echo "Die Skript-ID lautet: ". $SkriptID;