« Back to Product

Documentation

IPS_SetVariableCustomAction

 boolean IPS_SetVariableCustomAction (int $VariableID, int $ScriptID) 

Parameters

VariableID

ID of the variable

ScriptID

ID of the script that should be used as variable action. The nonexistent ScriptID 1 can be given to disable the default action. If a valid ScriptID is specified, it is used instead of the default action

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

This function assigns a custom action to the variable with the ID VariableID. The custom action is used in the visualization to forward a change in the variable to the proper function of the module. Examples of action scripts can be found here: Action Scripts

Example

IPS_SetVariableCustomAction(12345, 44431);
Any questions?