Dokumentation
IPS_SetEventCyclicDateFrom
Benötigt: IP-Symcon >= 3.1
boolean IPS_SetEventCyclicDateFrom (int $EreignisID, int $Tag, int $Monat, int $Jahr)
Parameterliste
| EreignisID | ID des zu verändernden Ereignisses |
| Tag | Start-Tag (0, 1..31) |
| Monat | Start-Monat (0, 1..12) |
| Jahr | Start-Jahr (0, 1970..2038) |
Rückgabewert
Konnte der Befehl erfolgreich ausgeführt werden, liefert er als Ergebnis TRUE, andernfalls FALSE.
Beschreibung
Die Funktion definiert das Startdatum für ein Ereignis.
Wird für Tag, Monat und Jahr jeweils 0 angegeben, so gibt es kein spezifisches Startdatum und es wird nicht berücksichtigt.
Das Start-Datum ist besonders relevant, wenn es ein Ereignis gibt, welches nicht Täglich ausgeführt wird. Bei z.B. einer Ausführung alle 2 Wochen am Montag kann über das Start-Datum der Referenzpunkt bestimmt werden, an dem das erste Ereignis auftritt. Dadurch kann gesteuert werden, ob das Ereignis in einer geraden oder ungeraden Kalenderwoche ausgeführt wird.
Beispiel
//Kein Startdatum dem Ereignis zuordnen
IPS_SetEventCyclicDateFrom($EreignisID, 0, 0, 0);