PC_Leave

Require: IP-Symcon >= 5.1

 boolean PC_Leave (int $InstanceID) 

Parameters

Returns

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

Description

The function sets the presence variable of the instance with ID InstanceID to false.
In addition, the presence is fixed for the dead-time set in the module and is not changed by status or pulse variables. During the dead-time, pulses on pulse-variables and changes in state-variables are completely ignored. After the dead-time, the presence is initially set based on the state variable.

Example

// Sets the presence of Presence-Control-Instance 12345 to "false"
PC_Leave(12345);