AfAboTimeAdd: Unterschied zwischen den Versionen
Jens (Diskussion | Beiträge) KKeine Bearbeitungszusammenfassung |
Jens (Diskussion | Beiträge) K Stand 4.1.09 |
||
(5 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 4: | Zeile 4: | ||
</tr> | </tr> | ||
<tr class="ProcSyntax"> | <tr class="ProcSyntax"> | ||
<td class="title"> | <td class="title"> AfAboTimeAdd(int1, int2) : int</td> | ||
<td class="platforms">[[file:DE_SymbolNoAPI.gif|alt=Nicht ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]</td> | <td class="platforms">[[file:DE_SymbolNoAPI.gif|alt=Nicht ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]</td> | ||
</tr> | </tr> | ||
Zeile 128: | Zeile 128: | ||
<td width="15%" class=Left>Siehe</td> | <td width="15%" class=Left>Siehe</td> | ||
<td width="85%" class=Right colspan="3"> | <td width="85%" class=Right colspan="3"> | ||
[[ | [[:Category:Befehle für Abonnements|Verwandte Befehle]], [[AfAboCreate|AfAboCreate()]], | ||
[[ | [[AfAboTimeEdit|AfAboTimeEdit()]] | ||
</td> | </td> | ||
</tr> | </tr> | ||
Zeile 139: | Zeile 139: | ||
</table> | </table> | ||
<div class="BigLang"> | <div class="BigLang"> | ||
<p>Mit dieser Anweisung wird der Versendezeitpunkt des Abonnements angegeben. In den Parametern wird die Abonnement-Id (int1) und das Benachrichtigungsintervall (int2) übergeben. Die Id wird von der Anweisung | <p>Mit dieser Anweisung wird der Versendezeitpunkt des Abonnements angegeben. In den Parametern wird die Abonnement-Id (int1) und das Benachrichtigungsintervall (int2) übergeben. Die Id wird von der Anweisung [[AfAboCreate|AfAboCreate()]] zurück gegeben. Für das Benachrichtigungsintervall stehen folgende Konstanten zur Verfügung:</p> | ||
<table class=lang> | <table class=lang> | ||
Zeile 289: | Zeile 289: | ||
<p>Einmalige Benachrichtigung für den Benutzer "admin" zum Ende des Jahres um 08:00 Uhr.</p> | <p>Einmalige Benachrichtigung für den Benutzer "admin" zum Ende des Jahres um 08:00 Uhr.</p> | ||
<pre class=source> | |||
... | ... | ||
tResult # | tResult # AfAboCreate(sAfAboTypeAbm, CnvAI(tAbmId, _FmtInternal), var tAboId); | ||
... | ... | ||
tResult # AfAboUserAdd(tAboId, sAfAboUserTypeUsr, 'admin'); | tResult # AfAboUserAdd(tAboId, sAfAboUserTypeUsr, 'admin'); | ||
Zeile 305: | Zeile 305: | ||
tResult # AfAboTimeAdd(tAboId, sAfCheckOnce); | tResult # AfAboTimeAdd(tAboId, sAfCheckOnce); | ||
... | ... | ||
</pre | </pre> | ||
<p> | <p> | ||
Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden: | Neben den [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerten]] | ||
können folgende Werte zurückgegeben werden: | |||
</p> | </p> | ||
<table class=lang> | <table class=lang> | ||
Zeile 342: | Zeile 343: | ||
</div> | </div> | ||
[[Category:Befehle für Abonnements]] | [[Category:Befehle für Abonnements]] | ||
Aktuelle Version vom 25. Oktober 2024, 12:59 Uhr
Mit dieser Anweisung wird der Versendezeitpunkt des Abonnements angegeben. In den Parametern wird die Abonnement-Id (int1) und das Benachrichtigungsintervall (int2) übergeben. Die Id wird von der Anweisung AfAboCreate() zurück gegeben. Für das Benachrichtigungsintervall stehen folgende Konstanten zur Verfügung:
Konstante | Wert | Bedeutung |
sAfCheckInterval | Benachrichtigungen im Abstand von Minuten | |
sAfCheckDaily | Benachrichtigungen im Abstand von Tagen | |
sAfCheckWeekly | Benachrichtigungen im Abstand von Wochen | |
sAfCheckMonthly | Benachrichtigungen im Abstand von Monaten | |
sAfCheckQuarterly | Benachrichtigung im Abstand von Quartalen | |
sAfCheckSemiyearly | Benachrichtigung im Abstand von halben Jahren | |
sAfCheckYearly | Benachrichtigung im Abstand von Jahren | |
sAfCheckOnce | Einmalige Benachrichtigung |
Da die Id des Abonnements und der Typ der Benachrichtigung in den Parametern übergeben wird, werden die entsprechenden Inhalte in den Feldpuffern ignoriert. Je nach angegebenem Typ müssen bestimmte Feldpuffer gefüllt werden:
Feldpuffer / Typ | sAfCheckInterval | sAfCheckDaily | sAfCheckWeekly | sAfCheckMonthly | sAfCheckQuarterly | sAfCheckSemiyearly | sAfCheckYearly | sAfCheckOnce |
gAfAboTimeNotifyInterval | ||||||||
gAfAboTimeNotifyTime | ||||||||
gAfAboTimeNotifyWeekDay | ||||||||
gAfAboTimeNotifyDayOfMonth | ||||||||
gAfAboTimeNotifyMonth | ||||||||
gAfAboTimeNotifyNextCheckDate | ||||||||
gAfAboTimeNotifyNextCheckTime |
Bei einer monatlichen, vierteljährlichen, halbjährlichen oder jährlichen Benachrichtigung genügt die Angabe des Tages im Monat oder des Wochentages. Eine Benachrichtigung wird dann zum Beispiel am 1. Tag des Monats oder am ersten Montag des Monates versendet.
Wird eine ungültige Kombination von Werten übergeben, gibt die Anweisung den Fehler _ErrValueInvalid zurück. Ein Abonnement kann nur einen Benachrichtigungszeitpunkt haben. Ist dieser bereits definiert, wird der Fehler _rExists zurückgegeben.
Beispiel:
Einmalige Benachrichtigung für den Benutzer "admin" zum Ende des Jahres um 08:00 Uhr.
... tResult # AfAboCreate(sAfAboTypeAbm, CnvAI(tAbmId, _FmtInternal), var tAboId); ... tResult # AfAboUserAdd(tAboId, sAfAboUserTypeUsr, 'admin'); ... gAfAboTimeNotifyType # 0; gAfAboTimeNotifyInterval # 0; gAfAboTimeNotifyTime # 00:00; gAfAboTimeNotifyWeekDay # 0; gAfAboTimeNotifyDayOfMonth # 0; gAfAboTimeNotifyMonth # 0; gAfAboTimeNotifyNextCheckDate # 31.12.2023; gAfAboTimeNotifyNextCheckTime # 08:00; tResult # AfAboTimeAdd(tAboId, sAfCheckOnce); ...
Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:
Konstante | Wert | Bedeutung |
_ErrOk | 0 | ok - kein Fehler aufgetreten |
_rExists | 6 | Das Abonnement hat bereits einen Benachrichtungszeitpunkt definiert. |
_ErrValueInvalid | -188 | In den Feldpuffern würde eine ungültige Kombination von Benachrichtigungszeitpunkten angegeben. |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.