Documentation
IPS_SetEventCyclicDateTo
Require: IP-Symcon >= 3.1
boolean IPS_SetEventCyclicDateTo (int $EventID, int $Day, int $Month, int $Year)
Parameters
| EventID | ID of the cyclic event to be changed |
| Day | End day (0, 1..31) |
| Month | End month (0, 1..12) |
| Year | End year (0, 1970..2038) |
Returns
If the command succeeds, it returns TRUE, otherwise FALSE.
Description
This command sets the end date for a cyclic event.
If the arguments for day, month, and year are 0, the event does not have a specific end date and is run indefinitely.
The event is run until the end date, including the end date itself
Example
//Set 1st January 2020 as end date for the event
IPS_SetEventCyclicDateTo($EventID, 1, 1, 2020);