Operation [ Micro Focus COBOL System Reference, Volume 1 ] MPE/iX 5.0 Documentation
Micro Focus COBOL System Reference, Volume 1
Operation
To use a library routine, use the name of the required routine in a COBOL
CALL statement.
Descriptions of Routines
Descriptions for all of the call-by-name routines appear alphabetically.
Key.
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 is not changed.)
status-code must be a numeric data item capable of holding positive
values from 0 to 65535; for example, PIC X(2) COMP-5.
The name of the routine must be coded in upper case.
Parameters:.
describes any parameters shown in the RETURNING and USING clause. A
parameter enclosed in brackets, for example, [parameter1] is optional and
might not be needed for all forms of the routine.
Remarks:.
provides any additional information necessary for the successful use of
the routine
On Entry:.
indicates which of the parameters shown are passed on entry
On Exit:.
indicates which of the parameters shown are returned on exit
MPE/iX 5.0 Documentation