Dokumentation
IPS_GetStatusVariable
array IPS_GetStatusVariable (int $InstanzID, string $VariableIdent)
Parameterliste
| InstanzID | ID der Instanz |
| VariableIdent | Status Variable Identifikator. Eine Auflistung kann über IPS_GetStatusVariableIdents abgerufen werden. |
Rückgabewert
Folgende Informationen stehen als key => value Paare zur Verfügung:
| Index | Typ | Beschreibung |
|---|---|---|
| VariableID | integer | Aktuelle ID der verknüpften IP-Symcon Variable |
| VariableIdent | string | Status Variablen Identifikator |
| VariableName | string | Standard Name der angelegten Variable |
| VariablePosition | integer | Standard Position der angelegten Variable |
| VariableProfile | string | Standard Profilname der angelegten Variable |
| VariableType | integer | Kompatibler Variablentyp (Siehe IPS_GetVariable) |
| VariableHasAction | boolean | Gibt an, ob intern eine Aktion definiert ist, die mit dieser Status Variable verknüpft wurde. |
| VariableUseAction | boolean | Gibt an, wie die vorhandene Aktion in der Visualisierung benutzt werden soll. |
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 liefert ein Array mit Informationen über die Status Variable von der Instanz InstanzID und der Status Variable mit dem Status Variablen Identifikator VariableIdent.
Beispiel
// bis Version 2.5
if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
print_r(IPS_GetStatusVariable(12345, "StatusVariable"));
}
// ab Version 2.6 Ersatzfunktion
$VariableIdent = "Statusvariable";
$InstanceID = 12345;
$id = IPS_GetObjectIDByIdent($VariableIdent, $InstanceID);
$v = IPS_GetVariable($id);
$result = Array(
"VariableID" => $id,
"VariableIdent" => $VariableIdent,
"VariableName" => "N/A",
"VariablePosition" => 0,
"VariableProfile" => $v['VariableProfile'],
"VariableType" => $v['VariableType'],
"VariableHasAction" => ($v['VariableAction'] > 0),
"VariableUseAction" => ($v['VariableAction'] > 0)
);
print_r($result);