Retrieve COBOL Error Handler (QLRRTVCE) API


  Required Parameter Group:

1 Current or pending error-handling exit program name Output Char(20)
2 Scope of error-handling exit program Input Char(1)
3 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve COBOL Error Handler (QLRRTVCE) API allows you to retrieve the name of the current or pending COBOL error-handling program. You can call it from any programming language; however, this API only retrieves the name of the error handling program that is called when an error occurs in an OPM COBOL/400 program.


Authorities and Locks

None.


Required Parameter Group

Current or pending error-handling exit program name
OUTPUT; CHAR(20)

The qualified name of the error-handling program for the current or pending COBOL run unit.

The 20 characters of this parameter are:

1-10 The name of the program object.
Valid values are:

*NONE No user-defined COBOL error handler has been set.
program-name The name of the error-handling program.
11-20 The library where the program object existed.
The valid value is:

library-name The library where the program object existed.

Scope of error-handling exit program
INPUT; CHAR(1)

The program can apply to a current or pending run unit.

Valid values are:

C Current COBOL run unit
P Pending COBOL run unit

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


Error Messages

Message ID Error Message Text
CPF3C90 E Literal value cannot be changed.
LBE7040 E Format of error code parameter is not correct.
LBE7051 E Scope parameter not valid.
LBE7052 E Run unit specified for error handler does not exist.
LBE7055 E Severe error while addressing parameter list. The API did not complete.

API introduced: V3R6
Top | High-level language APIs | APIs by category