FABHFSU user exit routine

The user exit routine enables you to perform additional selectivity or modification of segments before the segment data is written into the output data set. You can also control FABHFSU using various return codes from your exit routine.

The following topics includes product-sensitive programming interface information. See Programming interface information to understand the restrictions associated with this type of material.

Begin product-sensitive programming interface information.

Note: The user exit interface is compatible with the user exit interface of FABHFSU in DBT HSSR and IPR Unload. You can use the exit routine that you wrote for these utilities if that routine does not depend on the CON option, that is, if the routine does not expect that the segment prefix and the segment data are concatenated in contiguous virtual storage.

The routine must be link-edited in 31-bit addressing mode (AMODE 31). If the routine does not refer to the segment prefix area that is pointed to by the first parameter, you can link-edit the routine in 24-bit addressing mode (AMODE 24).

FABHFSU calls the user exit routine as an Assembler subroutine. The linkage convention follows the MVS™ standard. Exit routines must be placed into a load module library to which access is provided with a STEPLIB JCL statement.

At initialization of FABHFSU, and before any HSSR call is issued to the database to be unloaded, FABHFSU examines each PSB control statement to determine whether an exit routine has been specified. If one has been, it is loaded from its resident library.

The exit routine is called for each segment retrieved from the database before the segment record is written into the output data set.

If your exit routine needs some kind of initialization and termination processing, specify Y for the exit routine control option on the PSB control statement. For more information, see Initialization and termination processing in the exit routine.

If you want to modify the content of segments, specify the option Y or E for the segment modification option of the PSB control statement. For more information, see Modifying segments in user exits.

For best performance, coding the exit routines in Assembler language is recommended. However, exit routines in COBOL and PL/I exit routines are also supported for application programmers.

End product-sensitive programming interface information.