IEBCOPY User-Exit Parameter

Refer to the IEBCPARM mapping macro CPARM_EXIT_DSECT for a description of the IEBCOPY user exit parameters.

The IEBCPARM mapping macro maps the four word parameter list that is passed by the caller of IEBCOPY. The IEBCPARM mapping macro is created and deleted by the program that invokes IEBCOPY.

Table 1. IEBCPARM mapping macro
Offset - Decimal (Hex)	Name	Value	Description
00 (00)	CPARM_PARMLIST	DSECT
00 (00)	CPARM_PARMLIST_OPTIONS	DS A(CPARM_OPTIONS_SIZE)	Options list
04 (04)	CPARM_PARMLIST_DDNAMES	DS A(CPARM_DDNAMES_PREFIX)	DDNAMES list
08 (08)	CPARM_PARMLIST_PAGENUM	DS A(CPARM_PAGENUM_PREFIX)	PAGE NUMBER list
12 (0C)	CPARM_PARMLIST_EXITS	DS A(CPARM_EXIT_DSECT)	User exits parameter list
16 (10)	CPARM_PARMLIST_END	DS 0A	End of supported parameter-list
	CPARM_PARMLIST_LENGTH	EQU *-CPARM_PARMLIST	Parameter-list length
	CPARM_PARMLIST_LASTFLAG	EQU B'10000000'	LAST PARAMETER indicator

00 (00)	CPARM_OPTIONS_PREFIX	DSECT	Full-word boundary
Description: Maps the caller's options list. The CPARM_OPTIONS_SIZE address is contained in the first word in the IEBCOPY invocation parameter list.
00 (00)	CPARM_OPTIONS_SIZE	DC Y(L'CPARM_OPTIONS_TEXT)	OS EXEC PARM string length
02 (02)	CPARM_OPTIONS_TEXT	DC CL'100'	OS EXEC PARM character string

00 (00)	CPARM_DDNAMES_PREFIX	DSECT	Full-word boundary
Description: Maps the caller's DDnames list. The CPARM_DDNAMES_PREFIX address is contained in the second word in the IEBCOPY invocation parameter list.
00 (00)	CPARM_DDNAMES_SIZE	DC Y(L'CPARM_DDNAMES_LENGTH-2)	DDNAMES array length
02 (02)	CPARM_DDNAMES_1	DC XL8'00'	Reserved
10 (0A)	CPARM_DDNAMES_2	DC XL8'00'	Reserved
18 (12)	CPARM_DDNAMES_3	DC XL8'00'	Reserved
26 (1A)	CPARM_DDNAMES_4	DC XL8'00'	Reserved
34 (22)	CPARM_DDNAMES_IN	DC CL8'SYSIN'
42 (2A)	CPARM_DDNAMES_PRINT	DC CL8'SYSPRINT'
50 (32)	CPARM_DDNAMES_7	DC XL8'00'	Reserved
58 (3A)	CPARM_DDNAMES_UT1	DC CL8'SYSUT1'
66 (42)	CPARM_DDNAMES_UT2	DC CL8'SYSUT2'
74 (4A)	CPARM_DDNAMES_UT3	DC CL8'SYSUT3'
82 (52)	CPARM_DDNAMES_UT4	DC CL8'SYSUT4'
90 (5A)	CPARM_DDNAMES_12	DC XL8'00'	Reserved
98 (62)	CPARM_DDNAMES_13	DC XL8'00'	Reserved
106 (6A)	CPARM_DDNAMES_14	DC XL8'00'	Reserved
114 (72)	CPARM_DDNAMES_15	DC XL8'00'	Reserved
122 (7A)	CPARM_DDNAMES_16	DC XL8'00'	Reserved
	CPARM_DDNAMES_LENGTH	EQU *-CPARM_DDNAMES_SIZE

00 (00)	CPARM_PAGENUM_PREFIX	DSECT	Full-word boundary
Description: Maps the caller's page number list. The CPARM_PAGENUM_PREFIX address is contained in the third word in the IEBCOPY invocation parameter list.
00 (00)	CPARM_PAGENUM_SIZE	DC Y(L'CPARM_PAGENUM_TEXT)	PAGENUM string length
02 (02)	CPARM_PAGENUM_TEXT	DC CL4'0001'	PAGENUM character string

00 (00)	CPARM_EXIT_DSECT	DSECT	Double-word boundary
Description: Maps the caller's user exit parameter list. The CPARM_EXIT_DSECT address is contained in the fourth word in the IEBCOPY invocation parameter list.
00 (00)	CPARM_EXIT_LENGTH	DS H	Number of bytes that follow this field.
02 (02)	CPARM_EXIT_PARMS	DS 0H
02 (02)		DC XL6	Filler for DW alignment, must be zero
08 (08)	CPARM_EXIT_USR	DS CL8	This field allows the invoking program to be re-entrant. On all calls, IEBCOPY will copy this field to `CPLST_PARMLST_USER`
16 (10)	CPARM_EXIT_CONTROLSTMT_ADDR	DS AD(0)	Double word that contains a 31-bit address of the invoking program's control statement user exit or zero. The high order 33 bits must be zero. The exit will be called in 31-bit addressing mode.
20 (14)	CPARM_EXIT_CONTROLSTMT_ADD	EQU CPARM_EXIT_MEMBER_ADDR+4,4	31-bit address
24 (18)	CPARM_EXIT_MEMBER_ADDR	DS AD(0)	Double word that contains a 31-bit address of the invoking program's member-selection user exit or zero. The high order 33 bits must be zero. The exit will be called in 31-bit addressing mode.
28 (1C)	CPARM_EXIT_MEMBER_ADD	EQU CPARM_EXIT_MEMBER_ADDR+4,4	31-bit address
32 (20)	CPARM_EXIT_PARMS_LENGTH	EQU *-CPARM_EXIT_PARMS	Length of PARM LIST

If the address for the control statement exit is zero, IEBCOPY will read control statements from SYSIN or a substituted DD name as documented elsewhere. If the address for the control statement exit is non-zero, then IEBCOPY will not open SYSIN or a DD name substituted for it.