IPS_GetConfigurationForParent

 string IPS_GetConfigurationForParent (int $InstanzID) 

Parameterliste

Rückgabewert

JSON-codiertes Objekt mit den Eigenschaften, welche die Instanz für ihre übergeordnete Instanz vorgibt. Gibt die Instanz nichts vor, wird "{}" geliefert.

Beschreibung

Die Funktion liefert die Konfiguration, welche die Instanz mit der ID InstanzID für ihre übergeordnete Instanz vorgibt. Das Ergebnis ist ein JSON-codiertes Objekt, dessen Schlüssel die Namen der Eigenschaften der übergeordneten Instanz und dessen Werte die geforderten Werte sind.

Die Verwaltungskonsole nutzt diese Information, um die Werte beim Verbinden bzw. Erstellen der übergeordneten Instanz zu setzen. Die so vorgegebenen Eigenschaften können im Konfigurationsformular der übergeordneten Instanz nicht mehr verändert werden (siehe IPS_GetConfigurationsFromChildren).

Bei PHP-Modulen wird das Ergebnis der Funktion GetConfigurationForParent des Moduls geliefert. Ist diese nicht implementiert oder liefert sie einen leeren String, wird "{}" geliefert. Beginnt die Ausgabe nicht mit "{" (z.B. bei einer Fehlermeldung von PHP), schlägt die Funktion mit dieser Ausgabe als Fehler fehl. Die Vorgabe kann von der aktuellen Konfiguration abhängen, beispielsweise vom Typ der aktuell verbundenen übergeordneten Instanz.

Existiert die Instanz nicht, schlägt die Funktion mit "Instance #... does not exist" fehl.

Beispiel

// Konfiguration ermitteln, welche die Instanz 12345 (z.B. ein IRTrans Gateway an einem Client Socket) für ihre übergeordnete Instanz vorgibt
echo IPS_GetConfigurationForParent(12345);

/* liefert z.B.:
{"Port": 21000}
*/