Der Kommando-Returncode besteht aus drei Teilen:
Maincode, der einem Meldungsschlüssel entspricht, über den mit dem Kommando HELP-MSG-INFORMATION detaillierte Informationen abgefragt werden können.
Subcode1, der die aufgetretene Fehlersituation in eine Fehlerklasse einordnet, aus der abgeleitet werden kann, wie schwer wiegend ein Fehler ist. Der Wert von Subcode1 wird dezimal ausgegeben. Folgende fünf Fehlerklassen sind im BS2000 definiert:
Klasse A: kein Fehler
Der Wert ist null. Es kann normal weitergearbeitet werden.
Klasse B: Syntaxfehler
Der Wert ist eine Zahl von 1 bis 31. Das Kommando wurde syntaktisch falsch eingegeben. Eine Wiederholung der Eingabe ist nur nach Korrektur des Syntaxfehlers sinnvoll.
Klasse C: interner Fehler (Systemfehler)
Der Wert ist 32. Eine Wiederholung der Eingabe ist nur sinnvoll, wenn der interne Fehler behoben wurde.
Klasse D: Fehler, die keiner anderen Fehlerklasse zuzuordnen sind
Der Wert ist eine Zahl von 64 bis 127. Zur Bestimmung der weiteren Vorgehensweise sollte der Maincode ausgewertet werden.
Klasse E: Kommando kann vorübergehend nicht ausgeführt werden
Der Wert ist eine Zahl von 128 bis 130. Die Eingabe kann - sinnvollerweise nach einer Wartezeit - unverändert wiederholt werden. Die Dauer der Wartezeit wird eingeteilt in kurzfristig, langfristig und unbefristet.
Kurzfristig entspricht dem Wert 128 und bedeutet, dass ein Warten im Dialog als sinnvoll angesehen wird. Langfristig entspricht dem Wert 129 und bedeutet, dass ein Warten im Batchbetrieb als sinnvoll angesehen wird.Unbefristet entspricht dem Wert 130 und bedeutet, dass es unsicher ist, ob der Fehler überhaupt behoben wird.
Subcode2, der Zusatzinformationen (Wert ungleich null) enthalten kann. Der Wert von Subcode2 wird dezimal ausgegeben. Für den Fehlerfall (also Subcode1 ungleich null) ist die Verwendung von Subcode2 keinen Regeln unterworfen.
Subcode2 kann außer null die Werte 1 oder 2 annehmen, wenn kein Fehler aufgetreten ist.Subcode2 mit Wert 1 zeigt an, dass die angeforderte Leistung bereits vor Absetzen des Kommandos bestand. Subcode2 mit Wert 2 zeigt eine Sondersituation an und ist als Warnung einzustufen.
Der Kommando-Returncode kann nur mit SDF-P-Mitteln in S-Prozeduren und Dialogblöcken ausgewertet werden (siehe Handbuch „SDF-P“ [34]). Zur Auswertung siehe auch Beschreibung des Kommandos IF-BLOCK-ERROR und der Builtin-Funktionen MAINCODE, SUBCODE1 und SUBCODE2 im Abschnitt „Builtin-Funktionen".
Darstellung von Kommando-Returncodes
Kommando-Returncodes werden in Tabellenform in der Reihenfolge Subcode2, Subcode1, Maincode und Bedeutungstext dargestellt.
Ein Subcode2 mit dem Wert gleich null, d.h. es ist keine Zusatzinformation vorhanden, wird nicht in der Tabelle aufgeführt.
Sofern in einer Tabelle für einen bestimmten Kommando-Returncode Meldungen garantiert sind, enhält die Überschrift „Bedeutung“ den Zusatz „ / garantierte Meldungen“ und es werden die Meldungsschlüssel der garantierten Meldungen nach dem Bedeutungstext aufgezählt. Die Bedeutung dieser Meldungsschlüssel kann sich der Benutzer mit dem Kommando HELP-MSG ausgeben lassen.
Beispiel
(SC2) | SC1 | Maincode | Bedeutung / garantierte Meldungen |
|---|---|---|---|
0 | CMD0001 | Kommando fehlerfrei beendet | |
1 | 32 | CMD0500 | Syntaxbeschreibung in der aktuellen Syntaxdatei fehlerhaft garantierte Meldung: CMD0500 |
64 | CMD0554 | Kommando ohne Erfolg ausgeführt garantierte Meldungen: |