Invoking DFHCSDUP from a user program

It is possible to invoke DFHCSDUP from a user program. This method enables you to create a flexible interface to the utility. By specifying the appropriate entry parameters, your program can cause DFHCSDUP to pass control to an exit routine at any of five exit points. The exits can be used, for example, to pass commands to DFHCSDUP, or to respond to messages produced by DFHCSDUP processing.

You can run your user program:

Entry parameters for DFHCSDUP

When invoking DFHCSDUP, your program passes a parameter list addressed by register 1. It may pass up to five parameters, as described below:

OPTIONS
A list of character strings, separated by commas. (The information passed here is that which 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 for nnnn are 4 through 9999. The default value is 60.
NOCOMPAT|COMPAT
specifies whether DFHCSDUP is to be invoked in compatibility mode. By default, it is invoked in noncompatibility mode. For details of compatibility mode, see the CICS Resource Definition Guide.
UPPERCASE
specifies that output listings are to be printed entirely in uppercase characters. The default is to print in mixed case.
DDNAMES
A list of 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 113) 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 113.

Figure 113. 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:

Responsibilities of the user program

Before invoking DFHCSDUP, your calling program must ensure that:

Related concepts
An overview of DFHCSDUP
DFHCSDUP as a part of the resource definition process
Related tasks
Invoking a user program from DFHCSDUP
Related reference
The user exit points in DFHCSDUP
The sample program, DFH$CUS1
[[ Contents Previous Page | Next Page Index ]]