Kontrollstrukturen
ForEachIndex()
Diese Funktion läuft in einer Schleife über alle ganzzahligen Zählerwerte von einem gegebenen Startwert bis zu einem Endwert. Für jeden Zählerwert wird ein Makroausdruck ausgeführt.
Parameter | Datentyp | Beschreibung |
|---|---|---|
1* | Number | ganzzahliger Startwert der Zählschleife |
2* | Number | ganzzahliger Endwert der Zählschleife Der Endwert muss größer als oder gleich dem Startwert sein. |
3* | (keiner) | Makroausdruck, der für jeden Zählerwert ausgeführt wird Der Wert selbst wird in dem Ausdruck über die Variable |
Beispiele
Mit dem folgenden Makroausdruck werden beispielsweise die Zählerwerte von 1 bis 10 in einem Feld "Sum" aufsummiert, das den Initialwert 0 und als Endergebnis den Wert 55 hat:
ForEachIndex(1, 10, @Sum = @Sum + @Index)
SetCanceled(), SetError(), SetSuspended()
Diese Funktionen setzen das aktuelle Dokument in den Status "Canceled" (abgebrochen), "Error" (fehlerhaft) oder "Suspended" (ausgesetzt) und beenden somit unmittelbar die weitere Verarbeitung des Dokuments.
Hinweis
Im Verarbeitungsschritt "Input" wird noch keine Unterscheidung zwischen verschiedenen Abbruchstatus gemacht. Ein Verarbeitungsfehler oder benutzerdefiniert per Makro erzwungener Abbruch führt in diesem Schritt immer dazu, dass ein Stapel nicht eingelesen werden kann und in den Status "Error" versetzt wird.
Diese Makrofunktionen sollten somit nur in den Schritten "Process" und "Output" eingesetzt werden.
Parameter | Datentyp | Beschreibung |
|---|---|---|
1 | Text | optionaler benutzerdefinierter Text, der zusammen mit der entsprechenden Status- und Protokollmeldung ausgegeben wird |
Beispiele
SetError("Custom error message.") bricht die Dokumentverarbeitung mit einer benutzerdefinierten Fehlermeldung ab.
SetDeferred()
Diese Funktion setzt das aktuelle Dokument in den Status "Deferred" (zurückgestellt) und beendet somit unmittelbar – wenn auch nur temporär – die weitere Verarbeitung des Dokuments.
Hinweis
Im Verarbeitungsschritt "Input" wird noch keine Unterscheidung zwischen verschiedenen Abbruchstatus gemacht. Ein Verarbeitungsfehler oder benutzerdefiniert per Makro erzwungener Abbruch führt in diesem Schritt immer dazu, dass ein Stapel nicht eingelesen werden kann und in den Status "Error" versetzt wird.
Diese Makrofunktion sollten somit nur in den Schritten "Process" und "Output" eingesetzt werden.
Parameter | Datentyp | Beschreibung |
|---|---|---|
1* | Text | Zeitraum, für den des Dokument zurückgestellt wird, in der Syntax einer |
2 | Text | optionaler benutzerdefinierter Text, der zusammen mit der entsprechenden Status- und Protokollmeldung ausgegeben wird |
Beispiele
SetDeferred("30m", "Custom message.") stellt die Dokumentverarbeitung für 30 Minuten zurück.