Dokumentation
IPS_GetLinkIDByName
Benötigt: IP-Symcon >= 2.1
int IPS_GetLinkIDByName (string $LinkName, int $ÜbergeordneteID)
Parameterliste
LinkName | Zu suchender LinkName |
ÜbergeordneteID | Objekt, in deren direkten Unterobjekten gesucht werden soll |
Rückgabewert
ID des gefundenen Links, sonst FALSE
Beschreibung
Die Funktion versucht die ID des Links mit dem Namen LinkName, deren übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID des ersten gefundenen Links verwendet, deren Name mit LinkName übereinstimmt. Falls ein solcher Link 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
$LinkID = @IPS_GetLinkIDByName("Verlinkte Regenerfassung", $ÜbergeordneteID);
if ($LinkID === false)
echo "Link nicht gefunden!";
else
echo "Die Link-ID lautet: ". $LinkID;