Dokumentation

IPS_GetVariable

array IPS_GetVariable ( integer $VariablenID )

Parameterliste

VariablenID Die zu zeigende VariablenID

Rückgabewerte

Folgende Informationen stehen als key => value Paare zur Verfügung:

Index Typ Beschreibung
VariableAction integer ID der Instanz, die bei einer gewünschten Änderungen der Variable den Änderungswunsch entgegen nimmt. 0 bei keiner oder einer deaktivierten Verknüpfung.
VariableChanged integer Unix-Timestamp, wenn die Variable zuletzt verändert wurde
VariableCustomAction integer ID des Skriptes, dass 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) angegeben. (Ab Version 2.5 #2300)
VariableCustomProfile string Name vom Benutzer gegebenen Profil. Leer, falls kein Profil angeben.
VariableID integer VariablenID
VariableIsBinary boolean Gibt an, ob die String Variable über SOAP Base64 kodiert wird.
VariableIsLocked boolean Gibt an, ob diese Variable oberhalb des Variablenlimits ist und deshalb nicht beschrieben werden kann (Verfügbar ab Version 2.3).
VariableProfile string Name vom System gegebenen Profil. Leer, falls kein Profil angegben
VariableType (ab 4.0) integer Enthält den Variablentyp (0: Boolean, 1: Integer, 2: Float, 3: String)
VariableUpdated integer Unix-Timestamp, wenn die Variable zuletzt aktualisiert wurde
VariableValue (bis 3.4) array Siehe Tabelle Variablenwert (durch VariableType und GetValue ersetzt)

Tabelle: VariablenWert (bis 3.4)

Index Typ Beschreibung
ValueType integer Variablentyp (0: Boolean, 1: Integer, 2: Float, 3: String)
ValueBoolean boolean Wert der Variable abhängig vom ValueType
ValueInteger integer Wert der Variable abhängig vom ValueType
ValueFloat float Wert der Variable abhängig vom ValueType
ValueString string   Wert der Variable abhängig vom ValueType

Beschreibung

Der Befehl liefert ein Array mit Informationen über die Variable mit der ID VariablenID.

Um den Wert einer Variable zu bekommen muss ab Version 4.0 die Funktion GetValue genutzt werden

Ab Version 4.0 wird die bis 3.4 vorhandene Funktion als
"array IPS_GetVariableCompatibility( integer $VariablenID )" zur Verfügung gestellt.

Beispiel

// Ab Version 4.0
print_r(IPS_GetVariable(40770));
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsBinary] =>
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableType] => 0
    [VariableUpdated] => 1246039629
)
*/
 
print_r(IPS_GetVariableCompatibility(40770)); // Ab Version 4.0
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsBinary] =>
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableUpdated] => 1246039629
    [VariableValue] => Array
    (
        [ValueArray] => Array
        (
        )
 
        [ValueBoolean] => 1
        [ValueFloat] => 0
        [ValueIndex] => Array
        (
            [IndexInt] => 0
            [IndexStr] =>
            [IndexType] => 0
        )
 
        [ValueInteger] => 0
        [ValueString] =>
        [ValueType] => 0
    )
)
*/
 
// Bis Version 3.4
print_r(IPS_GetVariable(40770));
/* Beispielausgabe:
Array
(
    [VariableChanged] => 1246039629
    [VariableCustomAction] => 0
    [VariableCustomProfile] => BoolProfile
    [VariableID] => 40770
    [VariableIsBinary] =>
    [VariableIsLocked] =>
    [VariableProfile] => ~Switch
    [VariableUpdated] => 1246039629
    [VariableValue] => Array
    (
        [ValueArray] => Array
        (
        )
 
        [ValueBoolean] => 1
        [ValueFloat] => 0
        [ValueIndex] => Array
        (
            [IndexInt] => 0
            [IndexStr] =>
            [IndexType] => 0
        )
 
        [ValueInteger] => 0
        [ValueString] =>
        [ValueType] => 0
    )
)
*/