Filter
Top Products
2. If you specify the OBJECTS option, all the attributes of the resource
definitions are also extracted.
USERPROGRAM
is the name of the user-written program that is to process the data retrieved by
the EXTRACT command. You must supply a USERPROGRAM value.
When the user program is invoked
The user program can be invoked at nine different points during the processing of
the EXTRACT command by DFHCSDUP. However, your program is invoked at all
of these points only if you specify both LIST and OBJECTS on the EXTRACT
command. The invocation points are as follows:
1. At the beginning of EXTRACT processing. This is to allow for activities such as
file opening and storage acquisition.
2. At the beginning of LIST processing, but only if you have specified a LIST value
on the EXTRACT command.
3. At the start of every group being processed by the EXTRACT command.
4. At the start of each object (that is, resource type—TERMINAL, PROGRAM, and
so on) that is being processed, to allow for selection on an object or group
basis.
Note: If you have specified LIST but not OBJECTS on the EXTRACT
command, this invocation does not occur.
5. For every keyword (attribute) in the extracted object, but only if you have
specified OBJECTS on the EXTRACT command. This is to allow for the detailed
processing that may be necessary for cross-referencing.
6. At the end of every object—that is, when all of the keywords within an object
have been processed. This is to allow for the processing of data built up from
the detailed items, and it occurs once for each object.
7. At the end of every group, to allow for processing of the accumulated data.
8. At the end of LIST processing, if you have specified a LIST value on the
EXTRACT command.
9. When EXTRACT processing is complete, to allow for closing of files, release of
storage, and so on.
Parameters passed from DFHCSDUP to the user program
On every invocation of the user program, DFHCSDUP passes a parameter list
addressed by general register 1. The parameter list consists of a series of fullwords
that address the fields described in more detail below. The addresses set in the
parameter list vary, depending on the point that EXTRACT processing has reached.
The parameter list contains the following fields:
Function Type Ptr
The address of a halfword field that contains a code defining the point in
EXTRACT processing reached.
The function codes are as follows:
0 Initial call
2 List start call
4 Group start call
6 Object start call
Chapter 34. User programs for the system definition utility program (DFHCSDUP) 815