Dokumentation
IPS_GetObjectIDByName
int IPS_GetObjectIDByName (string $ObjektName, int $ÜbergeordneteID)
Parameterliste
ObjektName | Zu suchender ObjektName |
ÜbergeordneteID | Objekt, in dessen direkten Unterobjekten gesucht werden soll |
Rückgabewert
ID des gefundenen Objekts, sonst FALSE
Beschreibung
Die Funktion versucht die ID des Objekts mit dem Namen ObjektName, dessen übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID des ersten gefundenen Objekts verwendet, dessen Name mit ObjektName übereinstimmt. Falls ein solches Objekt gefunden wurde, wird dessen ID zurückgemeldet, andernfalls FALSE.
Der Parameter "ObjektName" darf kein Leerstring ("") sein.
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, muss der @ Operator genutzt, falls diese Meldung unterdrückt werden soll. Die genau Funktionsweise dieses Operators kann dem PHP Handbuch entnommen werden.
Beispiel
$ObjektID = @IPS_GetObjectIDByName("Regenerfassung", $ParentID);
if ($ObjektID === false)
echo "Objekt nicht gefunden!";
else
echo "Die Objekt-ID lautet: ". $ObjektID;