« Back to Product

Documentation

SetValueBoolean

 bool SetValueBoolean (int $VariableID, bool $Value) 

Parameters

VariableID

ID of the variable

Value

TRUE/FALSE

Returns

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

Description

The function sets the value of the IP-Symcon variable with the ID VariableID to Value. The selected variable must have the type Boolean. If the variable's type is not Boolean, the function stops with an error. A conversion from Integer or Float (0 = FALSE, otherwise TRUE) is done. For setting the variable type-unsafely you can use the function SetValue.

Example

SetValueBoolean(47788, true);  // Switch on alarm system
Any questions?