AfAboTimeAdd: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
← Zum vorherigen Versionsunterschied
K Stand 4.1.08
K Stand 4.1.13 Beispiel geändert, Helptip Ausführung angepasst
 
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 4: Zeile 4:
   </tr>
   </tr>
   <tr class="ProcSyntax">
   <tr class="ProcSyntax">
     <td class="title">&nbsp;AFAboTimeAdd(int1, int2) : int</td>
     <td class="title">&nbsp;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|Nicht ausführbar von der API]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen|Nicht ausführbar von der Programmierschnittstelle (DLL)]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen|Nicht ausführbar mit der Application Remote Control]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen|Ausführbar von der Script-API]]
    </td>
   </tr>
   </tr>
   <tr class="ProcShortDescription">
   <tr class="ProcShortDescription">
Zeile 128: Zeile 130:
   <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()]],  
[[:Category:Befehle für Abonnements|Verwandte Befehle]], [[AfAboCreate|AfAboCreate()]],  
[[AFAboTimeEdit|AfAboTimeEdit()]]
[[AfAboTimeEdit|AfAboTimeEdit()]]
   </td>
   </td>
</tr>
</tr>
Zeile 139: Zeile 141:
</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 [[AFAboCreate|AFAboCreate()]] zurück gegeben. Für das Benachrichtigungsintervall stehen folgende Konstanten zur Verfügung:</p>
<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 286: Zeile 288:
<p>Wird eine ungültige Kombination von Werten übergeben, gibt die Anweisung den Fehler <font class=source>_ErrValueInvalid</font> zurück. Ein Abonnement kann nur einen Benachrichtigungszeitpunkt haben. Ist dieser bereits definiert, wird der Fehler <font class=source>_rExists</font> zurückgegeben.</p>
<p>Wird eine ungültige Kombination von Werten übergeben, gibt die Anweisung den Fehler <font class=source>_ErrValueInvalid</font> zurück. Ein Abonnement kann nur einen Benachrichtigungszeitpunkt haben. Ist dieser bereits definiert, wird der Fehler <font class=source>_rExists</font> zurückgegeben.</p>


<p><b>Beispiel:</b>
== Beispiele ==


<p>Einmalige Benachrichtigung für den Benutzer "admin" zum Ende des Jahres um 08:00 Uhr.</p>
<tabber>
|-|ScriptAPI=
Einmalige Benachrichtigung für den Benutzer "admin" zum Ende des Jahres um 08:00 Uhr.
<pre class=source>
<pre class=source>
...
...
tResult # AFAboCreate(sAfAboTypeAbm, CnvAI(tAbmId, _FmtInternal), var tAboId);
tResult # AfAboCreate(sAfAboTypeAbm, CnvAI(tAbmId, _FmtInternal), var tAboId);
...
...
tResult # AfAboUserAdd(tAboId, sAfAboUserTypeUsr, 'admin');
tResult # AfAboUserAdd(tAboId, sAfAboUserTypeUsr, 'admin');
Zeile 301: Zeile 305:
gAfAboTimeNotifyDayOfMonth    # 0;
gAfAboTimeNotifyDayOfMonth    # 0;
gAfAboTimeNotifyMonth        # 0;
gAfAboTimeNotifyMonth        # 0;
gAfAboTimeNotifyNextCheckDate # 31.12.2023;
gAfAboTimeNotifyNextCheckDate # 31.12.2026;
gAfAboTimeNotifyNextCheckTime # 08:00;
gAfAboTimeNotifyNextCheckTime # 08:00;
tResult # AfAboTimeAdd(tAboId, sAfCheckOnce);
tResult # AfAboTimeAdd(tAboId, sAfCheckOnce);
...
...
</pre>
</pre>
</tabber>
<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 349:
</div>
</div>
[[Category:Befehle für Abonnements]]
[[Category:Befehle für Abonnements]]
[[Category:ListeAllerApiBefehleA]]

Aktuelle Version vom 5. Februar 2026, 12:04 Uhr

 AfAboTimeAdd(int1, int2) : int

Nicht ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Nicht ausführbar mit der Application Remote ControlAusführbar von der Script-API

Zeitpunkt der Benachrichtigung hinzufügen
int1 Id des Abonnements
int2 Intervall der Benachrichtigung
sAfCheckIntervall 1 Benachrichtigungen im Abstand von Minuten
sAfCheckDaily 2 Benachrichtigungen im Abstand von Tagen
sAfCheckWeekly 3 Benachrichtigungen im Abstand von Wochen
sAfCheckMonthly 4 Benachrichtigungen im Abstand von Monaten
sAfCheckQuarterly 5 Benachrichtigung im Abstand von Quartalen
sAfCheckSemiyearly 6 Benachrichtigung im Abstand von halben Jahren
sAfCheckYearly 7 Benachrichtigung im Abstand von Jahren
sAfCheckOnce 8 Einmalige Benachrichtigung
Feldpuffer
gAfAboTimeAboId int Id des Abonnements
gAfAboTimeNotifyType int Typ der Benachrichtigung
gAfAboTimeNotifyInterval int Abstand bis zur Benachrichtigung
gAfAboTimeNotifyTime time Uhrzeit der Benachrichtigung
gAfAboTimeNotifyWeekDay int Wochentag der Benachrichtigung
gAfAboTimeNotifyDayOfMonth int Tag im Monat der Benachrichtigung
gAfAboTimeNotifyMonth int Monat der Benachrichtigung
gAfAboTimeNotifyNextCheckDate date Datum der nächsten Benachrichtigung
gAfAboTimeNotifyNextCheckTime time Uhrzeit der nächsten Benachrichtigung
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAboCreate(), AfAboTimeEdit()

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
1
 Benachrichtigungen im Abstand von Minuten
sAfCheckDaily
2
 Benachrichtigungen im Abstand von Tagen
sAfCheckWeekly
3
 Benachrichtigungen im Abstand von Wochen
sAfCheckMonthly
4
 Benachrichtigungen im Abstand von Monaten
sAfCheckQuarterly
5
 Benachrichtigung im Abstand von Quartalen
sAfCheckSemiyearly
6
 Benachrichtigung im Abstand von halben Jahren
sAfCheckYearly
7
 Benachrichtigung im Abstand von Jahren
sAfCheckOnce
8
 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
X
X
X
X
X
X
X
gAfAboTimeNotifyTime
X
X
X
X
X
X
gAfAboTimeNotifyWeekDay
X
X
X
X
X
gAfAboTimeNotifyDayOfMonth
X
X
X
X
gAfAboTimeNotifyMonth
X
X
X
X
gAfAboTimeNotifyNextCheckDate
X
X
X
X
X
X
X
X
gAfAboTimeNotifyNextCheckTime
X
X
X
X
X
X
X
X

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.

Beispiele

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.2026;
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.

Abgerufen von „https://wiki.arcflow.net/index.php?title=AfAboTimeAdd&oldid=7915“