COBOL Manual for TNS and TNS/R Programs

Libraries and Utility Routines
HP COBOL Manual for TNS and TNS/R Programs—522555-006
13-57
COBOL85^SET^SORT^PARAM^VALUE and
COBOL_SET_SORT_PARAM_VALUE_
subsort-or-file-number
is a numeric operand whose value is the sort process to which the parameter
pertains or, if the parameter applies to a file, it is a file ordinal.
If a subsort-number is being supplied, the number of subsorts must have been
set previously (with the SUBSORT-COUNT parameter) and subsort-number
must be in the range 1 to that number. Subsort-number must be 0 if the parameter
applies to the distributor/collector process or if the number of subsorts has been
set to zero (a normal sort is implied). In the latter case, the parameter applies to
the normal sort.
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:
Usage Considerations:
•
Calling COBOL85^SET^SORT^PARAM^VALUE or
COBOL_SET_SORT_PARAM_VALUE_ in the CRE
A CRE HP COBOL program can call either
COBOL85^SET^SORT^PARAM^VALUE (the COBOL-environment routine) or
COBOL_SET_SORT_PARAM_VALUE_ (the equivalent CRE routine). If it calls
COBOL85^SET^SORT^PARAM^VALUE, it actually calls
COBOL_SET_SORT_PARAM_VALUE_ indirectly.
Value Meaning
0 The call was correct.
1The file-name does not name a sort-merge file.
2The param-id does not have one of the allowed values.
3The param-value is outside the allowed range.
4 If subsort-or-file-number is used to specify subsort-number, one of
these is true:
•
subsort-number was not within the range of the specified number of
subsorts.
•
subsort-number was required but not specified.
•
subsort-number was specified, was nonzero and a subsort-number
was not legal for this parameter.
If subsort-or-file-number is used to specify file-number, then
file-number is not within the range 1 through 32.
5 Space for the options block cannot be allocated.