Important Notice
The pages on this site contain documentation for very old MS-DOS software,
purely for historical purposes.
If you're looking for up-to-date documentation, particularly for programming,
you should not rely on the information found here, as it will be woefully
out of date.
Key (↑ Library of Routines)
◄Back► ◄Up► ◄Contents► ◄Index► ◄Back►
────────────────────────────────────────────────────────────────────────────
Descriptions for all of the call-by-name routines appear
alphabetically. Each description contains the routine name and
function and the following entries (as appropriate):
Syntax: shows the CALL statement you could use to call
the routine.
The optional RETURNING clause is also shown. Every
routine returns a value showing the result of the
operation. Unless otherwise indicated, zero
indicates success, nonzero indicates failure. This
value is left in the data-item specified in the
RETURNING clause, in this reference, status-code.
If this clause is omitted, the value is left in
the special register RETURN-CODE. (Note that if
call-convention bit two is set, RETURN-CODE will not
be changed.)
Parameters: describes any parameters shown in the RETURNING and
USING clause. A parameter enclosed in brackets,
for example, [parameter1] is optional and may not
be needed for all forms of the routine.
Description: provides any additional information necessary for
the successful use of the routine
Parameters on Entry: indicates which of the parameters shown are
passed on entry
Parameters on Exit: indicates which of the parameters shown are
returned on exit
The topic you see when you select a routine is its Summary,
showing its function, syntax, and a very brief description of its
parameters. On the button bar is a button to toggle between
Summary and Details. The Details describe the parameters fully
and give additional information. If this is not needed the
Details topic is blank.
The routines are listed in a 2-level menu, in categories
according to their purpose.
-♦-