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 des Medienobjekts mit dem Namen MedienName, dessen übergeordnetes Objekt die ID ÜbergeordneteID besitzt, zu ermitteln. Es wird die ID des ersten gefundenen Medienobjekts verwendet, dessen Name mit MedienName übereinstimmt. Falls ein solches Medienobjekt gefunden wurde, wird dessen ID zurückgemeldet, andernfalls FALSE.
Da die Suche durch das zusätzliche Kriterium (ÜbergeordneteID) auf die Kinder eines Objekts eingeschränkt 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 genaue 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;