on.varChange(varlist)
This routine is called when a monitored variable is changed by another application. The varlist is a list of variable names whose values were changed. This handler must return a value to indicate if it accepts the new value(s) or vetoes the change.
Valid return values are:
Value |
Brief Description |
Comment |
---|---|---|
0 |
Success |
The script application accepts the change. |
-1 |
Veto range |
The new value is unsatisfactory because it is outside the acceptable range, which is too low or too high. |
-2 |
Veto type |
The new value is unsatisfactory because its type cannot be used by the script application. |
-3 |
Veto existence |
Another application deleted the variable, and this application needs it. |
Introduced in platform.apiLevel = '1.0'