IBM SC33-1683-02 Appendix E. The example program for the XTSEREQ global user exit, DFH$XTSE

Appendix E. The example program for the XTSEREQ global
user exit, DFH$XTSE
This appendix lists the example global user exit program, DFH$XTSE. The example
shows you how to:
vUse EXEC CICS commands in a global user exit program
vUse EXEC CICS commands and XPI calls in the same exit program
vModify the command parameter list in EXEC interface exits such as XTSEREQ,
XICEREQ, and XFCREQ
vModify TemporaryStorage (TS) requests.
***********************************************************************
* *
* MODULE NAME = DFH$XTSE *
* *
* FUNCTION = *
* Example global user exit program to run at the XTSEREQ and *
* XTSEREQC exits. *
* *
* DESCRIPTION = *
* The program gives examples of: *
* 1) Coding Exec Interface global user exits, showing how to *
* modify and add parameters to the Command Parameter List. *
* 2) Issuing a mixture of EXEC CICS API and XPI calls within *
* the same global user exit program. *
* 3) Modifying Temporary Storage requests, by renaming the queue *
* name and allowing the SYSID to be added so that the request *
* is routed to a queue-owning region (QOR). *
* *
* ------------------------------------------------------------------- *
* NOTE that this program is only intended to DEMONSTRATE the use *
* of the TS request user exit XTSEREQ, and to show the sort of *
* information which can be obtained from the exit parameter list. *
* IT SHOULD BE TAILORED BEFORE BEING USED IN A PRODUCTION ENVIRONMENT.*
* ------------------------------------------------------------------- *
* *
* NOTES = *
* The important notes to remember when coding similar global user *
* exits are: *
* *
* 1) If the exit program modifies the Command Parameter List, you *
* MUST ensure that the storage used for additional fields such *
* as the SYSID is non-volatile. Here are examples of storage *
* that is safe: *
* a) Shared storage obtained by GETMAIN. This should be *
* obtained in the Request exit, and freed in the Request *
* Complete exit.. The shared storage address can be passed *
* using the 4-byte token in the DFHUEPAR parameter list. *
* b) Shared global work area storage. *
* c) Storage obtained by using the LOAD HOLD option. *
* d) TCTUA or CWA storage. *
Figure 113.Example exit program for the XTSEREQ exit (Part 1 of 16)
© Copyright IBM Corp. 1977, 1999 807