Dokumentation
IPS_SetVariableCustomAction
bool IPS_SetVariableCustomAction (int $VariablenID, int $SkriptID)
Parameterliste
| VariablenID | ID der Variable, der die Aktion zugeordnet werden soll |
| SkriptID | ID eines Skriptes, das als Aktion ausgeführt werden soll. Sofern eine vorhandene Standardaktion deaktiviert werden soll, kann die nichtvorhandene SkriptID Eins (1, |
Rückgabewert
Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.
Beschreibung
Die Funktion vergibt der Variable VariablenID eine benutzerdefinierte Aktion, die in der Visualisierung benutzt wird, um eine Änderung der Variable an die richtige Funktion des Moduls weiterzuleiten. Ein Beispiel für ein Aktionsskript kann hier gefunden werden: Aktionsskripte
Neben einer SkriptID können folgende Werte angegeben werden:
| Wert | Konstante | Beschreibung |
|---|---|---|
| 0 | VARIABLE_ |
Keine eigene Aktion. Die Standardaktion wird, sofern verfügbar, genutzt. |
| 1 | VARIABLE_ |
Die Standardaktion wird deaktiviert. |
Beispiel
// Skript 44431 als Aktion der Variable 12345 setzen
IPS_SetVariableCustomAction(12345, 44431);
// Standardaktion der Variable 12345 deaktivieren
IPS_SetVariableCustomAction(12345, VARIABLE_ACTION_DISABLED);
// Standardaktion der Variable 12345 wieder aktivieren
IPS_SetVariableCustomAction(12345, VARIABLE_ACTION_NONE);