« Back to Product

Documentation

SetStatus

Require: IP-Symcon >= 4.0

 boolean SetStatus (int $StatusValue) 

Parameters

StatusValue

The status value to which the instance should be set.

Returns

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

Description

Sets the status of an instance to the value of Status value.

Table: Instance status

Value Status
101 Instance is creating
102 Instance is active
103 Instance is deleting
104 Instance is inactive
105 Instance was not created
106 Instance is in standby
>=200 Instance is faulty

An error status over 200 can be self-defined.

This also has a direct influence on the display in the configuration forms in the "status"-area

Example

// sets the status to "inactive"
$this->SetStatus(104);
Any questions?