Makrofunktionen
Für die Parameterwerte der Makrofunktionen, die in diesem Abschnitt beschrieben werden, gelten die folgenden Konventionen:
Parameterwerte, die verpflichtend angegeben werden müssen, sind mit einem
*gekennzeichnet. Das beschränkt sich jedoch auf Parameter, für die programmintern eine explizite Prüfung stattfindet und die bei fehlendem Wert einen Verarbeitungsfehler auslösen.Bei vielen Parametern ist ein fehlender Wert fachlich gesehen zwar nicht sinnvoll, rein technisch aber zulässig. Das betreffende Makro liefert dennoch einen gültigen Rückgabewert. Ein Makro, das nach einer Zeichenfolge in einem Text suchen soll, gibt z. B. technisch korrekt "FALSE" zurück, auch wenn der Parameter für die Suchzeichenfolge nicht angegeben ist oder einen leeren Wert hat.
Parameter, die die Verwendung eines verschlüsselten Wertes oder Teil-Wertes in der Syntax
<§>… </§>unterstützen, sind mit einem(§)gekennzeichnet.Standardwerte für optionale Parameter werden im Beschreibungstext genannt. Das gilt jedoch nicht für Parameter, die technisch gesehen zwar nicht verpflichtend sind, aus fachlicher Sicht aber immer angegeben werden sollten. Abhängig vom Datentyp erhalten diese Parameter bei Fehlen implizit die folgenden Standardwerte:
textueller Wert: leere Zeichenfolge
numerischer Wert:
0Datumswert:
0001-01-01Wahrheitswert:
FALSE
Wenn zu einer Makrofunktion keine Parameterliste angegeben ist, ist die Funktion parameterlos und benötigt keine weitere Parametrierung.
Hinweise zur Arbeitsweise von Makrofunktionen
In der Regel werden Makros im Kontext der Verarbeitung eines konkreten Dokumentes ausgeführt. Makros, mit denen auf Eigenschaften oder Dateianlagen eines Dokumentes zugegriffen wird, beziehen sich daher immer auf das Dokument, das sich gerade in Bearbeitung befindet.
Einige Feldmakrofunktionen liefern einen leeren Wert zurück, wenn die Funktionen kein konkretes Ergebnis berechnen oder ein gesuchtes Element nicht finden. Wenn der Rückgabewert einen festen Datentyp hat, entspricht der leere Wert diesem Typ, z. B. 0 als leerer Zahlenwert. Wenn der Rückgabetyp jedoch variabel ist und aus dem aktuellen Verarbeitungskontext nicht ermittelt werden kann, wird ein leerer Textwert zurückgeliefert, weil ein String den Standarddatentyp darstellt.
Alle Makrofunktionen, in denen Zeichen oder Zeichenfolgen gesucht oder verglichen werden, unterscheiden nicht zwischen Groß- und Kleinschreibung, sofern dieses per Parameter nicht explizit konfigurierbar ist.
Hinweis
In den meisten Beispielen, die in den Beschreibungen der Makrofunktionen aufgeführt sind, werden konstante Literale als Parameter genutzt. Die Verwendung von konstanten Literalen dient der vereinfachten Darstellung der Parameterwerte und der Datentypen. In der Praxis können statt Konstanten auch Variablen genutzt werden.