Add Bindtime Exit (QbnAddBindtimeExit) API


  Required Parameter Group:

1 Qualified exit program name Input Char(20)
2 Exit program data Input Char(*)
3 Length of exit program data Input Binary(4)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Service Program: QBNPREPR

  Threadsafe: No

The Add Bindtime Exit (QbnAddBindtimeExit) API may be used by a compiler preprocessor to define an exit program that is called when the created module is bound into a ILE program.


Authorities and Locks

None


Required Parameter Group

Qualified exit program name
INPUT; CHAR(20)

The qualified name of the exit program to be called when the created module is bound into an ILE program. The first 10 characters contain the program name, which is left-justified and padded with blanks. The second 10 characters contain the name of the library where the exit program is located and is left-justified and padded with blanks.

The library name can be specified with the following special value:

*LIBL The library list.

The exit program is passed five parameters when called. The first two parameters are the exit program data and the exit program data length. The third parameter is a reserved CHAR(10). The fourth and fifth parameters are both reserved BINARY(4).

The exit program data being used in this API is defined by the user.

Exit program data
INPUT; CHAR(*)

This data is copied into the output source file member by the QbnEndPreProcessor API. When the exit program is called at ILE program creation time, a copy of the data is passed. The format of this data is specified by the supplier of the exit program. This data is ignored if the length of data to be passed to the length of exit program data parameter value is 0.

Length of exit program data
INPUT; BINARY(4)

The length of the data contained in the exit program data parameter.

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
CPF24B4 E Severe error while addressing parameter list.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF5CA4 E Error occurred while addressing API Parameter.
CPF5CEA E Library value &1 is not valid.
CPF5D22 E Not able to locate internal data.
CPF5D24 E Unexpected error occurred during preprocessor processing.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R1

[ Back to top | Program and CL Command APIs | APIs by category ]