Preprocessing Exit Program for Add

The Preprocessing Exit Program for Add allows for processing to take place before an exit program is added to an exit point. The preprocessing exit program will notify the registration facility through the return code parameter whether or not to add the exit program to the exit point.

Authorities and Locks

None.

Required Parameter Group

Exit point name

INPUT; CHAR(20)

The name of the exit point to which the exit program is being added.

Exit point format name

INPUT; CHAR(8)

The format name of the exit point to which the exit program is being added.

Exit program number

INPUT; BINARY(4)

The order in which the exit programs are to be run when multiple exit programs are associated with the exit point. The valid range is 1 through 2 147 483 647, where the processing sequence is from the lowest number to the highest number. Exit program numbers do not need to be consecutive. The following special values are allowed:

-1	The next lowest available number for that specific exit point will be assigned
-2	The highest available number for that specific exit point will be assigned

When the exit point provider stores the exit program information and one of the above special values is specified, the exit point provider will assign the exit program number. Otherwise, the registration facility will assign the exit program number.

Qualified exit program name

INPUT; CHAR(20)

The exit program that is to be added, and the library in which it is located. The first 10 characters contain the exit program name, and the second 10 characters contain the name of the library in which the exit program resides. A specific library name must be specified. The special values *LIBL and *CURLIB are not supported.

Exit program data

INPUT; CHAR(*)

The exit program data supplied for the exit program that is requesting to be added to the exit point. Pointer data will not be preserved in the exit program data parameter.

Length of exit program data

INPUT; BINARY(4)

The length of the exit program data. The valid length is 0 through 2048.

Exit program attributes

INPUT; CHAR(*)

The specified information for the exit program. See Exit Program Attribute Keys for more information. Any field not specified will be given the default value. The information is in the following format:

Number of variable length records

BINARY(4)

The total number of all of the variable length records.

Variable length records

The exit program attributes and their values. See Format for Variable Length Record for more information.

Return code

OUTPUT; BINARY(4)

Return code to notify success or failure. The following values are allowed:

0	The registration facility should not add the exit program to the exit point and should return an error to the caller of the Add Exit Program API.
1	The registration facility should add the exit program to the exit point. If the exit point provider has specified a Preprocessing Exit Program for Retrieve and returns this return code, an error will be issued to the caller of the Add Exit Program API.
2	The registration facility will not store the exit program information. The exit point provider stored the information. If the exit point provider has not specified a Preprocessing Exit Program for Retrieve and returns this return code, an error will be issued to the caller of the Add Exit Program API.
3	The registration facility will not replace the exit program. The exit point provider replaced the exit program. If the exit point provider did not specify a Preprocessing Exit Program for Retrieve and returns this return code, an error is issued to the caller of the Add Exit Program API.

Error Messages

Error notification is done through the return code parameter. No error messages will be accepted.

[ Back to top | Registration Facility APIs | APIs by category ]