« Zurück zu Produkt

Dokumentation

IPS_GetLibraries

 array IPS_GetLibraries (array $BibliothekIDs) 

Parameterliste

BibliothekIDs

Array mit den BibliothekIDs (string). Bei einem leeren Array werden alle Bibliotheken geliefert

Rückgabewert

Ein Array mit einem Eintrag je Bibliothek in der Reihenfolge von BibliothekIDs. Ist BibliothekIDs leer, ist die Reihenfolge der Einträge nicht garantiert. Jeder Eintrag hat denselben Aufbau wie bei IPS_GetLibrary.

Beschreibung

Warning

Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.

Die Funktion liefert die Informationen der Bibliotheken mit den IDs BibliothekIDs in einem Aufruf. Ist BibliothekIDs leer, werden alle Bibliotheken geliefert.

Warning

Die Funktion ist für den Abruf über die JSON-RPC Schnittstelle vorgesehen, z.B. für die Anzeige in der Konsole. In PHP-Skripten steht sie nicht zur Verfügung ("This function is not available for PHP") – dort kann das Ergebnis über IPS_GetLibraryList und IPS_GetLibrary ermittelt werden.

Ist ein Eintrag von BibliothekIDs kein String, schlägt die Funktion mit "Parameter type of LibraryIDs does not match" fehl. Existiert eine der Bibliotheken nicht, schlägt die Funktion mit "Cannot find library with GUID ..." fehl.

Beispiel

// Name und Version aller Bibliotheken über die JSON-RPC Schnittstelle anzeigen
$rpc = new JSONRPC("http://user:password@127.0.0.1:3777/api/");
foreach ($rpc->IPS_GetLibraries([]) as $library) {
    printf("%s: %s (Build %d)\n", $library['Name'], $library['Version'], $library['Build']);
}

/* liefert z.B.:
SzenenSteuerung: 1.1 (Build 0)
*/
Haben Sie noch Fragen?