Dokumentation
IPS_GetVariable
array IPS_GetVariable (int $VariablenID)
Parameterliste
| VariablenID | ID der Variable |
Rückgabewert
Folgende Informationen stehen als key => value Paare zur Verfügung:
| Index | Typ | Beschreibung | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| VariableID | integer | VariablenID | ||||||||||||
| VariableProfile | string | Name vom System gegebenen Profil. Leer, falls kein Profil angegeben. | ||||||||||||
| VariableAction | integer | ID der Instanz, die bei einer gewünschten Änderung der Variable den Änderungswunsch entgegennimmt. 0 bei keiner oder einer deaktivierten Verknüpfung. | ||||||||||||
| VariableCustomProfile | string | Name vom Benutzer gegebenen Profil. Leer, falls kein Profil angegeben. | ||||||||||||
| VariableCustomAction | integer | ID des Skriptes, das bei einer gewünschten Änderung der Variable über die Visualisierung gestartet werden soll. Sofern aktuell eine vorhandene Standardaktion deaktiviert wird, ist die nichtvorhandene SkriptID Eins (1, VARIABLE_) angegeben. 0 (VARIABLE_), falls keine eigene Aktion gesetzt ist. |
||||||||||||
| VariableUpdated | integer | Unix-Timestamp, wenn die Variable zuletzt aktualisiert wurde | ||||||||||||
| VariableChanged | integer | Unix-Timestamp, wenn die Variable zuletzt verändert wurde | ||||||||||||
| VariablePresentation | array | Vom System gegebene Darstellung. Leeres Array, falls keine Darstellung angegeben. | ||||||||||||
| VariableCustomPresentation | array | Vom Benutzer gegebene Darstellung. Leeres Array, falls keine Darstellung angegeben. | ||||||||||||
| VariableType | integer | Enthält den Variablentyp
|
||||||||||||
| VariableValue | mixed | Aktueller Wert der Variable. Der Datentyp entspricht dem VariableType. Siehe auch GetValue | ||||||||||||
| VariableIsLocked | boolean | Gibt an, ob diese Variable oberhalb des Variablenlimits ist und deshalb nicht beschrieben werden kann. |
Beschreibung
Die Funktion liefert ein Array mit Informationen über die Variable mit der ID VariablenID.
Beispiel
print_r(IPS_GetVariable(40770));
/* Beispielausgabe:
Array
(
[VariableID] => 40770
[VariableProfile] => ~Switch
[VariableAction] => 0
[VariableCustomProfile] =>
[VariableCustomAction] => 0
[VariableUpdated] => 1246039629
[VariableChanged] => 1246039629
[VariablePresentation] => Array
(
[PRESENTATION] => {4153A8D4-5C33-C65F-C1F3-7B61AAF99B1C}
[PROFILE] => ~Switch
)
[VariableCustomPresentation] => Array
(
)
[VariableType] => 0
[VariableValue] => 1
[VariableIsLocked] =>
)
*/