Documentation
IPS_SetEventCyclicDateFrom
Require: IP-Symcon >= 3.1
boolean IPS_SetEventCyclicDateFrom (int $EventID, int $Day, int $Month, int $Year)
Parameters
| EventID | ID of the cyclic event to be changed |
| Day | Start day (0, 1..31) |
| Month | Start month (0, 1..12) |
| Year | Start year (0, 1970..2038) |
Returns
If the command succeeds, it returns TRUE, otherwise FALSE.
Description
This command sets the start date for a cyclic event.
If the arguments for day, month, and year are 0, the event does not have a specific start date and starts immediately.
The start date is especially relevant for events that are not executed daily. For example, when an event is run every 2 weeks, the start date determines the reference point of the first execution. It can be used to control if the event should run during odd or even calendar weeks.
Example
//No start date for the event
IPS_SetEventCyclicDateFrom($EventID, 0, 0, 0);