Dokumentation
IPS_SetStatusVariableUseAction
boolean IPS_SetStatusVariableUseAction (int $InstanzID, string $VariableIdent, boolean $BenutzteAktion)
Parameterliste
InstanzID | ID der Instanz |
VariableIdent | Status Variable Identifikator. Eine Auflistung kann über IPS_GetStatusVariableIdents abgerufen werden. |
BenutzteAktion | Gibt an, ob die Aktion in der Visualisierung genutzt werden soll. |
Rückgabewert
Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis TRUE, andernfalls FALSE.
Beschreibung
Die Dokumentation dieser Funktion ist nur noch aus Kompatibilitätsgründen vorhanden und sollte ab IP-Symcon 2.5 nicht mehr verwendet werden. Diese Funktion wird ab Version 2.5 nur noch emuliert und sollte durch die entsprechenden Ersatzfunktionen ausgetauscht werden. Eine Ersatzfunktion befindet sich im Beispiel (siehe unten).
Die Funktion setzt, ob die intern verknüpfte Aktion einer bestimmten Instanz InstanzID und der Status Variable mit dem Status Variablen Identifikator VariableIdent benutzt werden soll.
Beispiel
if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
IPS_SetStatusVariableUseAction(12345, "StatusVariable", false); //Per WebFront nicht mehr schaltbar machen
}
// ab Version 2.6 Ersatzfunktion
$VariableIdent = "Statusvariable";
$InstanceID = 12345;
$UseAction = false;
$id = IPS_GetObjectIDByIdent($VariableIdent, $InstanceID);
if ($UseAction) {
IPS_SetVariableCustomAction($id, 0); // Standardaktion aktivieren
} else {
IPS_SetVariableCustomAction($id, 1); // Standardaktion deaktivieren
}