7.48.1 ENDPRINT Parameters

IO_ERROR

IO_STATUS

REPORT_NUM

REPORT_NUM

Specifies the number of the report that is to be ended. If no report number is specified report number 1 is assumed. The report number specified can be any number in the range 1 to 8.

IO_STATUS

Specifies the name of a field that is to receive the "return code" that results from the I/O operation. This parameter is only valid for printer files opened by the UPRINT command.

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.

For values, refer to I/O Return Codes .

IO_ERROR

Specifies what action is to be taken if an I/O error occurs when the command is executed. This parameter is only valid for printer files opened by the UPRINT command.

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.

*NEXT indicates that control should be passed to the next command.

*RETURN specifies that in a program mainline control is to be returned to the caller and in a subroutine control is to be returned to the caller routine or the program mainline.

If none of the previous values are used you must nominate a valid command label to which control should be passed.