Documentation
IPS_SetEventActive
bool IPS_SetEventActive (int $EventID, bool $Active)
Parameters
| EventID | ID of the event to be changed |
| Active | Indicates whether the event should be activated (TRUE) or deactivated (FALSE) |
Returns
If the function succeeds, it returns TRUE, otherwise FALSE.
Description
After the activation / deactivation, the new status can be read via IPS_GetEvent. It is possible to determine the next execution date for active cyclic and schedule events. For a deactivated event the NextRun value is zero.
Example
IPS_SetEventActive($EventID, true); // Activates the event