Dokumentation
IPS_SetEventConditionDateRule
Benötigt: Symcon >= 4.4
bool IPS_SetEventConditionDateRule (int $EreignisID, int $BedingungsID, int $RegelID, int $Vergleich, int $Tag, int $Monat, int $Jahr)
Parameterliste
| EreignisID | ID des zu verändernden Ereignisses |
|||||||||||||||||||||
| BedingungsID | ID der Bedingung, welche die Regel beinhaltet |
|||||||||||||||||||||
| RegelID | Eindeutige ID für diese Regel. IDs müssen nur für diese Bedingung eindeutig sein. |
|||||||||||||||||||||
| Vergleich |
|
|||||||||||||||||||||
| Tag | Tag mit dem das aktuelle Datum verglichen wird |
|||||||||||||||||||||
| Monat | Monat mit dem das aktuelle Datum verglichen wird |
|||||||||||||||||||||
| Jahr | Jahr mit dem das aktuelle Datum verglichen wird |
Rückgabewert
Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.
Beschreibung
Diese Funktion modifiziert die Regel mit der ID RegelID der Bedingung mit der ID BedingungsID des Ereignisses mit der ID EreignisID. Die Regel vergleicht das aktuelle Datum mit den Tag, Monat und Jahr, entsprechend der Vergleichsoperation Vergleich. Falls keine Regel mit der ID RegelID existiert, wird eine erstellt.
Liegt einer der Werte außerhalb des gültigen Bereichs (Tag < 0 oder > 31, Monat < 0 oder > 12, Jahr < 0), wird die Regel mit der ID RegelID gelöscht. Existiert keine Regel mit dieser ID, wird ein Fehler ausgegeben.
Tag, Monat und Jahr können auf 0 gesetzt und so als Wildcard genutzt werden
Welche RegelID welche Regel beinhaltet kann via IPS_GetEvent nachgesehen werden.
Beispiel
//Eine AND Bedingung hinzufügen
IPS_SetEventCondition(12345, 0, 0, EVENT_CONDITION_OPERATION_AND);
// Fügt hinzu/Modifiziert die Regel mit der ID 2 beim Ereignis mit der ObjektID 12345
// Es ist die erste Jahreshälfte -> aktuelles Datum < 01.07.2018
IPS_SetEventConditionDateRule(12345, 0, 2, EVENTCONDITIONCOMPARISON_SMALLER, 1, 7, 2018);
// Lösche die Regel mit der ID 1
IPS_SetEventConditionDateRule(12345, 0, 1, 0, -1, 0, 0);