Preprocessing Exit Program for Retrieve

Required Parameter Group:

1	Continuation handle	Input	Char(16)
2	Receiver variable	Output	Char(*)
3	Length of receiver variable	Input	Binary(4)
4	Format name	Input	Char(8)
5	Exit point name	Input	Char(20)
6	Exit point format name	Input	Char(8)
7	Exit program number	Input	Binary(4)
8	Exit program selection criteria	Input	Char(*)
9	Return code	Output	Binary(4)

The Preprocessing Exit Program for Retrieve allows for the exit point provider to store the exit program information. The registration facility will not store the exit program information, only exit point information. The Preprocessing Exit Program for Add and the Preprocessing Exit Program for Remove are required when this preprocessing exit program is supplied. The preprocessing exit program will notify the registration facility through the return code parameter whether or not the exit information returned is complete and accurate.

Authorities and Locks

None.

Required Parameter Group

Continuation handle

INPUT; CHAR(16)

The value returned to the API in the receiver variable when partial information is returned. This parameter is used when there is more information available to return than what could fit in the receiver variable.

Receiver variable

OUTPUT; CHAR(*)

The variable in which the preprocessing exit program will return the exit information to the registration facility. This information must be returned in the format specified in the format name parameter.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable.

Format name

INPUT; CHAR(8)

The format of the exit information to be returned. One of the following format names will be specified by the Retrieve Exit Information API:

EXTI0100	Exit point information
EXTI0200	Basic exit program information
EXTI0300	Complete exit program information

Refer to EXTI0100 Format, EXTI0200 Format, and EXTI0300 Format for more information.

Exit point name

INPUT; CHAR(20)

The name of the exit point for which information is being retrieved.

Exit point format name

INPUT; CHAR(8)

The format name associated with the exit point.

Exit program number

INPUT; BINARY(4)

The number of the exit program. When format EXTI0100 is specified, this field should be ignored. The following values are allowed:

-1	All exit programs for the exit point are returned.
exit program number	The exit program with the specified exit program number is returned. The valid range is 1 through 2 147 483 647.

Exit program selection criteria

INPUT; CHAR(*)

The selection criteria to be used when selecting which exit programs associated with the exit point are to be returned. When format EXTI0100 is specified, this field should be ignored. The information is in the following format:

Number of selection criteria: BINARY(4); The total number of selection criteria. Zero is specified if no selection criteria are specified. The maximum value for this field is 1.
Selection criteria array: CHAR(*); The selection criteria. Refer to Format for Exit Program Selection Criteria for more information.

Return Code

OUTPUT; BINARY(4)

The return code to notify success or failure. If there is no information to return, set the number of exit programs returned field to 0 and specify success (1) for the return code. The following values are allowed:

0	The information returned to the registration facility is incomplete or inaccurate.
1	The information returned to the registration facility is complete and accurate.

Error Messages

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