Dokumentation
IPS_SetOption
bool IPS_SetOption (string $Option, mixed $Wert)
Parameterliste
| Option | Name der Option, z.B. "ThreadCount" |
| Wert | Neuer Wert der Option |
Rückgabewert
Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.
Beschreibung
Diese Funktion ist nur für den internen Gebrauch vorgesehen und kann sich jederzeit ohne Ankündigung ändern oder entfallen.
Die Funktion setzt den Spezialschalter Option auf den Wert Wert. Die Namen aller Optionen liefert IPS_GetOptionList.
Die meisten Optionen werden von IP-Symcon nur beim Start übernommen. Eine Änderung wird daher in der Regel erst nach einem Neustart von IP-Symcon wirksam.
Der neue Wert wird sofort in den Einstellungen gespeichert und von IPS_GetOption geliefert. IPS_GetOptionEx liefert unter Current weiterhin den Wert, mit dem IP-Symcon gestartet wurde, bis ein Neustart erfolgt ist.
Wert wird in den Datentyp der Option umgewandelt. Für eine boolesche Option ergibt ein Integer- oder Float-Wert größer 0 TRUE, ein String nur bei "True" TRUE. Für eine Integer- oder Float-Option wird ein String als Zahl interpretiert, für eine String-Option werden Zahlen als Text gespeichert.
Existiert die Option nicht, schlägt die Funktion mit "Cannot find option ... node in settings" fehl. Neue Optionen können mit dieser Funktion nicht angelegt werden.
Beispiel
// Protokollierung der Skriptausführungen deaktivieren
IPS_SetOption("ScriptWatch", false);
// Anzahl der PHP Threads erhöhen
IPS_SetOption("ThreadCount", 100);
// Die Änderungen werden erst nach einem Neustart von IP-Symcon wirksam