Dokumentation
IPS_GetMediaIDByName
int IPS_GetMediaIDByName (string $MedienName, int $ÜbergeordneteID)
Parameterliste
MedienName | Zu suchender MedienName |
ÜbergeordneteID | Objekt, in deren direkten Unterobjekten gesucht werden soll |
Rückgabewert
ID des gefundenen Medienobjekts, sonst FALSE
Beschreibung
Die Funktion versucht die ID von Median mit dem Namen MediaName, dessen übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID des ersten gefundenen Medien verwendet, dessen Name mit MediaName übereinstimmt. Falls ein solches Medium gefunden wurde, wird dessen ID zurückgemeldet, andernfalls FALSE.
Da hier im Gegensatz zu IPS_GetMediaID 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. Benutzen Sie den @ Operator, falls Sie diese Meldung unterdrücken wollen. Die genau Funktionsweise dieses Operators können Sie dem PHP Handbuch entnehmen.
Beispiel
$MedienID = @IPS_GetMediaIDByName("MeinBild", $ÜbergeordneteID);
if ($MedienID === false)
echo "Bild nicht gefunden!";
else
echo "Die Media-ID lautet: ". $MedienID;