« Back to Product

Documentation

IPS_SetStatusVariableUseAction

 boolean IPS_SetStatusVariableUseAction (int $InstanceID, string $VariableIdent, boolean $UseAction) 

Parameters

InstanceID

ID of the instance

VariableIdent

Status variable identifier. A listing can be found on IPS_GetStatusVariableIdents

UseAction

Indicates whether the action should be used in the visualization

Returns

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

Description

Warning

The documentation of this function only for compatibility reasons and should not be used in IPSymcon 2.5 and newer versions. Since version 2.5, the functionality is only emulated and should be replaced by other functions. Since version 4.0, these functions can only be accessed if the Special Switch "Compatibility Functions" is activated.

The command sets whether the internally linked action of a specific instance InstanceID and the status variable with the status variable identifier VariableIdent should be used.

Example

if(IPS_StatusVariableExists(12345, "StatusVariable"))
{
    IPS_SetStatusVariableUseAction(12345, "StatusVariable", false); // Do not make it switchable via WebFront
}
Any questions?