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 here. 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
8    Keyword detail call
10    Object end call
12    Group end call
14    List end call
16    Final call.

Workarea Ptr

This is the address of a field containing the address of a fullword to be used by the user application to store the address of any user-acquired work area.

Back translated command Ptr

The address of a fullword that contains the address of a 75-byte area of storage that contains the EXTRACT command that is being processed.

List name Ptr

The address of an 8-byte field that identifies the RDO list from which the current object is taken. This value is set only on the ‘list start’ and ‘list end’ calls.

Group name Ptr

The address of an 8-byte field that identifies the RDO group from which the current object is taken. This value is set on the ‘group start’, ‘group end’, ‘object start’, ‘object end’, and ‘keyword’ calls.

Object type Ptr

The address of a 12-byte field that identifies the type of object (such as TRANSACTION, PROGRAM, and so on), and is set only on the ‘object start’, ‘object end’, and ‘keyword’ calls.

Object name Ptr

The address of an 8-byte field that contains the name of the object, and is set only on the ‘object start’, ‘object end’, and ‘keyword’ calls.

Keyword name Ptr

The address of a 12-byte field that contains the name of the keyword being processed, and is set only on ‘keyword’ calls.

Keyword length Ptr

The address of a halfword field that contains the length of the value associated with the keyword, and is set only on ‘keyword’ calls.

Keyword Value Ptr

The address of the storage area that contains the value associated with the keyword, and is set only on ‘keyword’ calls.