7.126.1 UPRINT Parameters

COLUMN_SEP

FIELDS

IO_ERROR

IO_STATUS

REPORT_NUM

SPACE

START_COL

TITLE

7.127 USE

FIELDS

Specifies either the field(s) that are to be printed or the name of a group that specifies the field(s) to be printed.

TITLE

Specifies the title (if any) that is to be printed on the report.

*NONE, which is the default value indicates that no title is required.

If a title is required specify the title in quotes.

REPORT_NUM

Specifies the number of the report that is to be used to print the line. If no report number is specified report number 1 is assumed. The report number specified can be any number in the range 1 to 9. Up to 9 reports can be produced simultaneously.

SPACE

Specifies the number of lines to be spaced before printing the line. If no value is specified 1 is assumed. The value specified must be in the range 1 to 3.

WIDTH

Specifies the width (in characters) of the report. If no value is specified *DEFAULT is assumed which means that the system default report width will be used. Refer to other sections in this guide for more details of system default values. Otherwise specify a value in the range 1 to 198.

COLUMN_SEP

Specifies the number of spaces (in characters) that are to be left between columns in the report. If no value is specified 1 is assumed. Otherwise specify a value in the range 1 to 20.

START_COL

Specifies the column in which the first field is to be printed. If no value is specified 1 is assumed. Otherwise specify a value in the range 1 to 198.

IO_STATUS

Specifies the name of a field that is to receive the "return code" that results from the I/O operation.

If the default value of *STATUS is used the return code is placed into a special field called #IO$STS which can be referenced in the RDML program just like any other field.

If a user field is nominated to receive the return code it must be alphanumeric with a length of 2. Even if a user field is nominated the special field #IO$STS is still updated.

Refer to I/O Command Return Codes Table for I/O operation return codes.

IO_ERROR

Specifies what action is to be taken if an I/O error occurs when the command is executed.

An I/O error is considered to be a "fatal" error. Some examples are file not found, file is damaged, file cannot be allocated. These types of errors stop the function from performing any processing at all with the file involved.

If the default value of *ABORT is used the function will abort with error message(s) that indicate the nature of the I/O error.

If the default value *ABORT is not used you must nominate a valid command label to which control should be passed if an I/O error occurs.