Dokumentation
RegisterVariableBoolean
Benötigt: IP-Symcon >= 4.0
int RegisterVariableBoolean (string $Ident, string $Name, array $Darstellung, int $Position)
Parameterliste
| Ident | Ident der Statusvariable |
| Name | Name der Statusvariable |
| Darstellung | Die Konfiguration der Darstellung als Array. Ein Profil kann über das Legacy Profil gesetzt werden. |
| Position | Position im Objektbaum und somit auch in der Visualisierung. |
Rückgabewert
VariablenID der erstellten Statusvariable
Beschreibung
Diese Funktion erstellt eine Statusvariable vom Typ Boolean mit dem Ident Ident dem Namen Name. Es kann noch angegeben werden, welche Darstellung genutzt werden und auf welcher Position die Statusvariable stehen soll.
Der Aufbau der Darstellungen ist hier näher beschrieben.
Darstellungen können ab der Version 8.0 verwendet werden. In vorherigen Versionen können Profile über den Presentation Parameter als String gesetzt werden.
Diese Funktion kann auch aufgerufen werden wenn die Variable bereits existiert. In diesem Fall wird ausschließlich das die Darstellung aktualisiert, sofern diese abweichend ist. Sollte der Variablentyp anders sein, wird die Variable ohne Rückfrage gelöscht und neu mit dem korrektem Variablentyp neu erstellt.
Über GetIDForIdent kann die VariablenID ermittelt werden, sodass diese nirgends gespeichert werden muss.
Beispiel
$variablenID = $this->RegisterVariableBoolean("Schalter", "Lichtschalter im Wohnzimmer");
$this->RegisterVariableBoolean("Schalter", "Lichtschalter", ["PRESENTATION" => VARIABLE_PRESENTATION_SWITCH]);