gtpi1m3h | System Installation Support Reference |
The FILE_STCCR user exit, UPX3, performs accounting or utility functions
when the TPF system files a short-term common control record (STCCR).
The FILE_STCCR user exit also provides a mechanism that allows you to
supply your own function to convert the STCCR from its current format in
processor storage to pool expansion (PXP) format or to a user-defined format
that is compatible with PXP format.
The FILE_STCCR user exit is called by the FILE_STCCR function from
segment CYH3.
Input
- Data Level E
- Data level E (DE) contains the STCCR to be filed. The STCCR is in
32-way loosely coupled pool support format or a user-defined format compatible
with 32-way loosely coupled pool support format.
Return Values
- R6=0
- Default return code. If this value is returned, CYH3 converts the
STCCR from 32-way loosely coupled pool support format to PXP format.
Use this return code if you code this user exit and do not change the STCCR on
data level E (DE).
- R6=1
- If this value is returned, CYH3 does not change the STCCR. Use this
return code if you code this user exit to convert the STCCR to PXP format or a
user-defined format compatible with PXP format. The user exit must file
the STCCR on data level E (DE) to DASD. CYH3 performs a BACKC macro to
the caller of CYH3.
- R6=2
- If this value is returned, CYH3 does not change the STCCR. Use this
return code if you code this user exit to convert the STCCR to PXP format or a
user-defined format compatible with PXP format and you want CYH3 to file the
STCCR to DASD. CYH3 files the STCCR to DASD and returns to the function
that called it.
- EBXSW4=0
- If you set the return code to 1 (R6=1), you must set EBXSW4=0 if STCCR was
successfully filed to DASD. If the return code is set to 0 or 2, EBXSW4
is set by CYH3.
- EBXSW4=2
- If you set the return code to 1 (R6=1), you must set EBXSW4=2 if there was
an error while filing STCCR to DASD. If the return code is set to 0 or
2, EBXSW4 is set by CYH3.
Programming Considerations
- The FILE_STCCR user exit is called by CYH3 when the format indicator in
the STCCR (CY$32LC in CY$CON) on data level E (DE) is not set to 32-way
loosely coupled pool support format.
- As shipped by IBM, this user exit calls the BACKC macro to return to the
caller. The STCCR on data level E (DE) is not changed.
- You can use all data levels and registers if the data levels and registers
are saved before use and restored before returning to the caller.
- If you code this user exit and set the return code to 0 (R6=0), the STCCR
on data level E (DE) must be in 32-way loosely coupled pool support
format.
- If you code this user exit and set the return code to either 1 (R6=1) or 2
(R6=2), the STCCR on data level E (DE) must be in PXP format or a user-defined
format compatible with PXP format.
References
See TPF Database Reference for more information
about pool support.