The Extract Exit - IBM SC34-6814-04 Customization Manual

Return codes
XPI calls

The extract exit

The extract exit is invoked at various points during processing of the EXTRACT
command. The points are listed in "When the user program is invoked" on page
815.
Note:
When invoked
Exit-specific parameters
826
Customization Guide
UEPCMDA
Pointer to the address of a command.
UEPCMDL
Address of a halfword containing the length of the command text.
The maximum length that can be specified is 1536 bytes.
UERCNORM (X'00')
Continue processing.
UERCDONE (X'04')
No more commands to process. (This is equivalent to reaching
end-of-file on the SYSIN file.)
UERCERR
Irrecoverable error. This causes DFHCSDUP to terminate with a
return code of '8'.
Must not be used.
1. If you do not specify an EXTRACT user exit routine on the entry linkage
to DFHCSDUP, or on the USERPROGRAM keyword, a syntax error
occurs.
2. A user exit routine specified on the USERPROGRAM keyword is used in
preference to one specified on the entry linkage.
Invoked multiple times during processing of the EXTRACT command.
EXTRACT_FUNCTION_CODE_PTR
Address of a halfword containing a code that defines the point in
EXTRACT processing reached. The EXTRACT function codes are
listed in EXTRACT function codes.
EXTRACT_WORK_AREA_PTR
Address of a fullword containing the address of the EXTRACT work
area.
EXTRACT_BACKTRAN_COMMAND_PTR
Address of a fullword containing the address of the EXTRACT
command being processed.
EXTRACT_CSD_LIST_NAME_PTR
Address of an 8-byte field containing the name of the list whose
data is being extracted. This value is set only on 'list start' and 'list
end' calls.
EXTRACT_CSD_GROUP_NAME_PTR
Address of an 8-byte field containing the name of the group whose