COBOL Manual for TNS and TNS/R Programs

Libraries and Utility Routines
HP COBOL Manual for TNS and TNS/R Programs—522555-006
13-47
COBOL85^RETURN^SORT^ERRORS and
COBOL_RETURN_SORT_ERRORS_
library-reference
is a mnemonic-name in the SPECIAL-NAMES paragraph. For the COBOL85
compiler, this mnemonic-name is associated with either
$SYSTEM.SYSTEM.CBL85UTL or some other object file containing an object
copy of COBOL85^RETURN^SORT^ERRORS. For the NMCOBOL compiler, this
mnemonic-name is associated with either $SYSTEM.SYSnn.ZCOBSRL or some
other object file containing an object copy of
COBOL_RETURN_SORT_ERRORS_.
sd-name
is the COBOL name of a file defined in an SD entry. The specification of the
remaining parameter is applied to any subsequent SORT or MERGE statements
that refer to this file name. If a subsequent call to the same routine refers to the
same sd-name, that call resets the specifications for any subsequent SORT or
MERGE statements that refer to the same file name.
error-report
is an 01 level item with this structure:
01 error-info
02 error-message-text PIC X(64).
02 error-message-length NATIVE-2.
02 error-code.
03 file-system-code NATIVE-2.
03 input-file-index NATIVE-2.
03 sort-code NATIVE-2.
02 error-source NATIVE-2.
02 subsort-index NATIVE-2.
02 subsort-id NATIVE-2
For the meaning of these fields, see the FastSort Manual discussion of
SORTERRORSUM. The input-file-index and sort-code are partial word
fields in that section, but are full word fields in the above record. If this parameter is
omitted, any previously set error reporting is cleared.
return-code
is an identifier of a numeric data item in which an error value will be returned. The
expected values and their respective meanings are:
Value Meaning
0 The call was correct.
1 file-name does not name a sort-merge file.
2 error-report is not the correct length.
5 Space for the options block cannot be allocated.