Documentation
SetStatus
Require: Symcon >= 4.0
bool 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 | Constant | Status |
|---|---|---|
| 101 | IS_CREATING |
Instance is creating |
| 102 | IS_ACTIVE |
Instance is active |
| 103 | IS_DELETING |
Instance is deleting |
| 104 | IS_INACTIVE |
Instance is inactive |
| 105 | IS_NOTCREATED |
Instance was not created |
| 106 | IS_STANDBY |
Instance is in standby |
| >=200 | IS_EBASE |
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(IS_INACTIVE);