IPS_GetOptionEx

 array IPS_GetOptionEx (string $Option) 

Parameterliste

Rückgabewert

Folgende key => value Paare sind enthalten. Der Datentyp der Werte (bool, int, float oder string) entspricht dem Typ der Option:

Beschreibung

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

Die Funktion liefert zum Spezialschalter Option den aktuell wirksamen Wert, den Standardwert und den gespeicherten Wert.

Wird eine Option mit IPS_SetOption geändert, wird der neue Wert sofort gespeichert und unter Pending geliefert. Current behält den Wert, mit dem IP-Symcon gestartet wurde, bis zum nächsten Neustart. Unterscheiden sich Current und Pending, ist für die Übernahme der Änderung also ein Neustart erforderlich. Ohne Änderung seit dem Start sind beide Werte gleich.

Existiert die Option nicht, schlägt die Funktion mit "Cannot find option ... node in settings" fehl. Für Optionen, die zwar noch in den Einstellungen stehen, aber von der installierten Version nicht mehr verwendet werden, schlägt sie mit "Cannot find default value for this option" fehl.

Beispiel

$option = IPS_GetOptionEx("ThreadCount");
print_r($option);

if ($option['Current'] !== $option['Pending']) {
    echo "Die Änderung wird erst nach einem Neustart wirksam";
}

/* liefert z.B.:
Array
(
    [Current] => 50
    [Default] => 50
    [Pending] => 100
)
Die Änderung wird erst nach einem Neustart wirksam
*/