Skip to content

Latest commit

 

History

History
101 lines (85 loc) · 8.79 KB

README_DE.md

File metadata and controls

101 lines (85 loc) · 8.79 KB

ARSBlue ToolBox-4-Iris -- Makro Package

Dokumentation: Die Dokumentation steht sowohl in Englisch README.md als auch in Deutsch README_DE.md zur Verfügung.

Include Makro

Die arsblue.Include Include-Datei beinhaltet alle unten beschriebenen Makros:

ObjectScript Makros

Die arsblue.OS Include-Datei beinhaltet Makros, die ObjectScript Befehle abkürzen bzw. für IRIS Standard Funktionen sprechende Namen geben sollen.

Makro Beschreibung
Zeichenketten-Makros:
$$$NULL Entspricht dem NULL-Charakter ($C(0)), der in einigen IRIS Funktionen zur Anwendung kommt (z.B. Streams, ...).
$$$ISNULL(%val) Prüft, ob der übergebene Wert (%val) eine leere Zeichenkette ($$$NULLOREF) oder ein NULL-Charakter ($$$NULL) ist.
$$$IFNULL(%val,%def) Prüft den übergebenen Wert (%val) und liefert den Default-Wert (%def) wenn $$$ISNULL zutrifft ansonsten den Wert (%val) selbst.
Zahlen-Makros:
$$$MININT Der Wert der kleinsten möglichen Integer-Zahl in IRIS.
$$$MAXINT Der Wert der größten möglichen Integer-Zahl in IRIS.
$$$ISNUMERIC(%val) Prüft, ob der übergeben Wert (%val) ein numerischer Wert ist. Vornullen und die speziellen $DOUBLE-Werte INF, -INF und NAN werden als Zeichenketten interpretiert.
Datum- bzw. Zeit-Makros:
$$$DAYINSEC Die Anzahl Sekunden für einen Tag (24 Stunden * 60 Minuten * 60 Sekunden = 86400 Sekunden).
$$$TimeStamp Der aktuelle Zeitstempel im Format yyyyMMddHHmmss.SSSSS
$LIST-Makros:
$$$ISLIST(%val) Prüft, ob der übergebene Wert (%val) eine $LIST ist. Im Gegensatz zu $LISTVALID darf es sich nicht um einen Leerstring handeln.
$$$ISLISTEMPTY(%val) Prüft, ob der übergeben Wert (%val) eine $LIST mit mindestens einem nicht NULL-Eintrag ist.
Konvertierungsmakros:
$$$GETVALUE(%val) Prüft, ob der übergebene Wert (%val) eine Zahl ist und konvertiert diese als Zahl (z.B. $DOUBLE, ...) oder als Zeichenkette.
$$$GETVALUEQ(%val) Wie $$$GETVALUE - nur werden Zeichenketten mit doppelten Anführungszeichen umschlossen.

Status Makros

Die arsblue.Status Include-Datei beinhaltet Makros, die %Library.Status Abfragen erleichtern.

Makro Beschreibung
$$$ISSTATUS(%val) Prüft, ob der übergebene Wert (%val) eine gültige %Library.Status Zeichenkette ist.
Warnungen:
$$$WARNING(%msg) Erzeugt einen Fehlerstatus mit dem Fehlercode 0 und der übergebenen Warnung (%msg).
$$$ISWARNING(%sc) Prüft, ob es sich beim Status um eine Warnung handelt.
$$$GETWARNING(%sc) Liefert die Warnung aus dem Status (%sc).
QUIT-Mit Rückgabewert-Makros:
$$$Quit(%sc) Prüft, ob der Status (%sc) ein Fehler ist und beendet den aktuellen Befehlsblock mit diesem Status.
Achtung:
Nur verwenden, wenn der Status in einer Variablen zur Verfügung steht, ein Befehl würde mehrmals ausgeführt werden!
$$$QuitIf(%expr,%msg) Prüft, ob der Befehl (%expr) wahr ist und beendet den aktuellen Befehlsblock mit einem generellen Fehler mit dem übergebenen Fehlertext (%msg).
$$$QuitOnSQLError(%rs,%rssql) Setzt das %SQL.StatementResult-Objekt mit dem Variablennamen (%rs) und prüft, ob das Objekt einen SQL-Fehlercode aufweist und beendet den aktuellen Befehlsblock in diesem Fall mit einem SQL-Fehler mit der Fehlermeldung aus dem Objekt.
$$$QuitError(%msg) Beendet den aktuellen Befehlsblock mit einem generellen Fehler mit dem übergebenen Fehlertext (%msg).
THROW-Makros:
$$$Throw(%sc) Prüft, ob der Status (%sc) ein Fehler ist und wirft eine Status-Ausnahme.
Achtung:
Nur verwenden, wenn der Status in einer Variablen zur Verfügung steht, ein Befehl würde mehrmals ausgeführt werden!
$$$ThrowIf(%expr,%msg) Prüft, ob der Befehl (%expr) wahr ist und wirft eine generelle Fehler-Ausnahme mit dem übergebenen Fehlertext (%msg).
$$$ThrowOnSQLError(%rs,%rssql) Setzt das %SQL.StatementResult-Objekt mit dem Variablennamen (%rs) und prüft, ob das Objekt einen SQL-Fehlercode aufweist und wirft in diesem Fall eine SQL-Fehler-Ausnahme mit der Fehlermeldung aus dem Objekt.
$$$ThrowError(%msg) Wirft eine generelle Fehler-Ausnahme mit dem übergebenen Fehlertext (%msg).
RETURN-Makros:
$$$Return(%sc) Prüft, ob der Status (%sc) ein Fehler ist und beendet die Methode mit diesem Status.
Achtung:
Nur verwenden, wenn der Status in einer Variablen zur Verfügung steht, ein Befehl würde mehrmals ausgeführt werden!
$$$ReturnOnError(%sc) Setzt den Status (%sc) und prüft, ob der Status ein Fehler ist und beendet die Methode mit diesem Status.
Achtung:
Im Gegensatz zu $$$Return funktioniert dieses Makro auch für übergebene Befehle!
$$$RETURNONERROR(%sc,%expr) Setzt das Ergebnis des Befehls (%expr) mit dem Variablennamen (%sc) und prüft, ob der Status ein Fehler ist und beendet die Methode mit diesem Status.
$$$ReturnIf(%expr,%msg) Prüft, ob der Befehl (%expr) wahr ist und beendet die Methode mit einem generellen Fehler mit dem übergebenen Fehlertext (%msg).
$$$ReturnOnSQLError(%rs,%rssql) Setzt das %SQL.StatementResult-Objekt mit dem Variablennamen (%rs) und prüft, ob das Objekt einen SQL-Fehlercode aufweist und beendet die Methode in diesem Fall mit einem SQL-Fehler mit der Fehlermeldung aus dem Objekt.
$$$ReturnError(%msg) Beendet die Methode mit einem generellen Fehler mit dem übergebenen Fehlertext (%msg).
QUIT-Ohne Rückgabewert-Makros:
$$$Break(%expr) Prüft, ob der Befehl (%expr) wahr ist und beendet den aktuellen Befehlsblock.
$$$BreakOnError(%expr) Prüft, ob der Befehl (%expr) ein Fehler-Status ist und beendet den aktuellen Befehlsblock.
$$$BREAKONERROR(%sc,%expr) Setzt das Ergebnis des Befehls (%expr) mit dem Variablennamen (%sc) und prüft, ob der Status ein Fehler ist und beendet den aktuellen Befehlsblock.
$$$BreakOnSQLError(%rs,%rssql) Setzt das %SQL.StatementResult-Objekt mit dem Variablennamen (%rs) und prüft, ob das Objekt einen SQL-Fehlercode aufweist und beendet den aktuellen Befehlsblock.
CONTINUE-Makros:
$$$Continue(%expr) Prüft, ob der Befehl (%expr) wahr ist und beginnt den nächsten Schleifendurchlauf.
$$$ContinueOnError(%expr) Prüft, ob der Befehl (%expr) ein Fehler-Status ist und beginnt den nächsten Schleifendurchlauf.
$$$CONTINUEONERROR(%sc,%expr) Setzt das Ergebnis des Befehls (%expr) mit dem Variablennamen (%sc) und prüft, ob der Status ein Fehler ist und beginnt den nächsten Schleifendurchlauf.
$$$ContinueOnSQLError(%rs,%rssql) Setzt das %SQL.StatementResult-Objekt mit dem Variablennamen (%rs) und prüft, ob das Objekt einen SQL-Fehlercode aufweist und beginnt den nächsten Schleifendurchlauf.

National Language Support Makros

Die arsblue.NLS Include-Datei beinhaltet Makros, die NLS Einstellungen auslesen.

Makro Beschreibung
$$$NLSFormat(%idx) Liefert die Einstellung für den entsprechenden Formatierungsindex (s. %syNLS Include-Datei)
$$$NLSMonthAbbr Liefert die abgekürzten Monatsnamen der aktuellen NLS-Einstellungen.
$$$NLSMonthName Liefert die vollständigen Monatsnamen der aktuellen NLS-Einstellungen.
$$$NLSWeekdayAbbr Liefert die abgekürzten Wochentagsnamen der aktuellen NLS-Einstellungen.
$$$NLSWeekdayName Liefert die vollständigen Wochentagsnamen der aktuellen NLS-Einstellungen.

JavaScript Makros

Die arsblue.JS Include-Datei beinhaltet JavaScript-Makros. Die arsblue.util.Json Include-Datei ist Teil der JavaScript Makros.

Makro Beschreibung
Zahlenmakros:
$$$JSMININT Der Wert der kleinsten möglichen Integer-Zahl in JavaScript.
$$$JSMAXINT Der Wert der größten möglichen Integer-Zahl in JavaScript.
$$$ISJSNUMERIC(%val) Prüft, ob der übergeben Wert (%val) ein numerischer JavaScript Wert ist. Vornullen und die speziellen $DOUBLE-Werte INF, -INF und NAN werden als Zeichenketten interpretiert.
Konvertierungsmakros:
$$$GETJSVALUE(%val) Prüft, ob der übergebene Wert (%val) eine JavaScript-Zahl ist und konvertiert diese als Zahl (z.B. $DOUBLE, ...) oder als Zeichenkette.
$$$GETJSVALUEQ(%val) Wie $$$GETJSVALUE - nur werden Zeichenketten mit einfachen Anführungszeichen umschlossen.