$ERR.HEL: Difference between revisions

Content added Content deleted
(added this page which is HELp for the $ERR.REX (REXX) program. -- ~~~~)
 
m (corrected some typos.)
Line 1: Line 1:
This   '''$ERR.HEL'''   page is the contents of the information displayed when the   '''$ERR.REX'''   REXX program invokes the   '''$H.REX''' program to display the   '''help''' documentation for the   '''$ERR.REX'''   REXX program.

<pre>
<pre>
The $ERR command is used to display an error message (or messages) from a
The $ERR command is used to display an error message (or messages) from a
Line 15: Line 17:
The format of the $ERR command is:
The format of the $ERR command is:


╔═════════════════════════════════════════════════════════════════════════════╗
╔══════════════════════════════════════════════════════════════════════════════╗
║ ║
║ ║
║ $ERR errnum EXECname {xxx yyy zzz} {..F=fff} ║
║ $ERR errNum EXECname {xxx yyy zzz} {..F=fff} ║
║ , ║
║ , ║
║ ? ║
║ ? ║
║ ?AUTHOR ║
║ ?AUTHOR ║
║ ?FLOW ║
║ ?FLOW ║
║ ?SAMPLES ║
║ ?SAMPLES ║
║ ║
║ ║
╚═════════════════════════════════════════════════════════════════════════════╝
╚══════════════════════════════════════════════════════════════════════════════╝


───where:
───where:


? shows this help file (press ESC to quit when viewing).
? shows this help file (press ESC to quit when viewing).


?AUTHOR shows the author of this program.
?AUTHOR shows the author of this program.
Line 34: Line 36:
?FLOW shows the external execution flow of this program.
?FLOW shows the external execution flow of this program.


?SAMPLES shows some sample uses (press ESC to quit when viewing).
?SAMPLES shows some sample uses (press ESC to quit when viewing).


errnum is the number of the error message(s) (numbered from 1400──►1499),
errNum is the number of the error message(s) (numbered from 1400──►1499),
or 14.1 (which indicates that the REXX program has been HALTed).
or 14.1 (which indicates that the REXX program has been HALTed).


0 exits $ERR.
0 exits $ERR.
'
'
EXECname is the name of the invoking EXEC and if not a comma, it's shown in
EXECname is the name of the invoking EXEC, and if not a comma, it's shown
the last error message (see above).
in the last error message (see above).


xxx yyy zzz are optional arguments that the error message text(s) may require.
xxx yyy zzz are optional arguments that the error message text(s) may require.
Line 51: Line 53:




The return code is set to the last two digits of the errnum, except for error
The return code is set to the last two digits of the errNum, except for error
1468, which uses the retcode (error code) from the 3rd argment which is an
1468, which uses the retCode (error code) from the 3rd argument which is an
code code recieved from another command that failed.
code code received from another command that failed.


Another special case is error 14.1 which signifies that the REXX program has
Another special case is error 14.1 which signifies that the REXX program has
Retrieved from "https://rosettacode.org/wiki/$ERR.HEL"