Entry parameters for DFHCSDUP

When your program invokes DFHCSDUP, it passes a parameter list addressed by register 1. The program can pass up to five parameters.

OPTIONS
A list of character strings, separated by commas. This information is the information that would otherwise be passed on the PARM keyword of the EXEC statement of JCL. A maximum of four options can be specified:
CSD({READWRITE|READONLY})
Specifies whether you require read-write or read-only access to the CSD.
PAGESIZE(nnnn)
Specifies the number of lines per page on output listings. Valid values are 4 through 9999. The default value is 60.
NOCOMPAT|COMPAT
Specifies whether DFHCSDUP is invoked in compatibility mode. By default, it is not invoked in compatibility mode. For details of compatibility mode, see Sharing the CSD between different releases of CICS.
UPPERCASE
Specifies that output listings are printed entirely in uppercase characters. The default is to print in mixed case.
DDNAMES
A list of data definition names (ddnames) that, if specified, are substituted for those normally used by DFHCSDUP.
HDING
The starting page number of any listing produced by DFHCSDUP. You can use this parameter to ensure that subsequent invocations produce logically numbered listings. If this parameter is not specified, the starting page number is set to 1.

The length of the page number data (field bb in Figure 1) must be 0 or 4. The page number, if supplied, must be four numeric EBCDIC characters. The field, if present, is updated upon exit from DFHCSDUP with a number one greater than that of the last page printed.

DCBS
The addresses of a set of data control blocks for use internally by DFHCSDUP. Any DCBs (or ACBs) that you specify are used internally, instead of those normally used by DFHCSDUP.

Note that if you specify both replacement ddnames and replacement DCBs, the alternative DCBs are used, but the alternative ddnames are disregarded.

EXITS
The addresses of a set of user exit routines to be invoked during processing of DFHCSDUP.
The structure of the parameter list is shown in Figure 1.
Figure 1. Entry parameters for DFHCSDUP
The picture shows, in graphical format, the structure of the parameter list passed to DFHCSDUP, as described in the preceding paragraphs.
You should note the following:
  • Each parameter contains a length field, followed by some functional data.
  • The functional data for the DDNAMES, DCBS, and EXITS parameters contains multiple subentries.
  • The parameters OPTIONS, DDNAMES, and HDING are aligned on a halfword boundary, and the first two bytes bb contain the binary number of bytes in the following functional data.
  • The parameters DCBS and EXITS are aligned on a fullword boundary, and the first four bytes ‘00bb' contain the binary number of fullwords in the following functional data.
  • If the bb field for any parameter is zero, the parameter is ignored.
  • If a subentry in the functional data is all binary zeros, it is ignored.
  • If any subentry is not within the length indicated by bb, it is ignored.
  • In the DDNAMES functional data, each subentry consists of an 8-byte ddname to replace a default ddname used by DFHCSDUP. DFHCSDUP does not use the first three subentries of the DDNAMES parameter. The fourth, fifth, and sixth subentries, if present, replace the ddnames of DFHCSD, SYSIN, and SYSPRINT, respectively.
  • In the DCBS functional data, each subentry consists of two fullwords. The first word is not used by CICS®. The second word contains the address of an open DCB or ACB. You must ensure that the DCB or ACB has been opened with the correct attributes, which are as follows:
    PRIMARY CSD
    AM=VSAM,MACRF=(KEY,DIR,SEQ,IN,OUT)
    INPUT FILE
    DSORG=PS,MACRF=GL,LRECL=80,RECFM=FB

    The address of any end-of-data routine (EODAD) or I/O error routine (SYNAD) in the DCB is overlaid by DFHCSDUP.

    OUTPUT FILE
    DSORG=PS,MACRF=PL,LRECL=125,RECFM=VBA

    DFHCSDUP does not use the first three subentries of the DCBS parameter. The fourth, fifth, and sixth subentries, if present, are used instead of the internal DCBs or ACBs for DFHCSD, SYSIN, and SYSPRINT, respectively.

  • In the EXITS parameter, each subentry consists of a single fullword containing the address of an exit routine. You must specify the exit routines in the order shown in Figure 1. (The user exits are described in The user exit points in DFHCSDUP.)