Retrieve information about a user exit.
INQUIRE EXITPROGRAM >>-INQUIRE EXITPROGRAM(data-value)------------------------------> .------------------------------. V | >----+--------------------------+-+---------------------------->< +-EXIT(data-value)---------+ +-ENTRYNAME(data-area)-----+ +-APIST(data-value)--------+ +-CONCURRENTST(data-value)-+ +-CONNECTST(cvda)----------+ +-ENTRY(ptr-ref)-----------+ +-FORMATEDFST(cvda)--------+ +-GAENTRYNAME(data-area)---+ +-GALENGTH(data-area)------+ +-GAUSECOUNT(data-area)----+ +-INDOUBTST(cvda)----------+ +-NUMEXITS(data-area)------+ +-PURGEABLEST(cvda)--------+ +-QUALIFIER(data-area)-----+ +-SHUTDOWNST(cvda)---------+ +-SPIST(cvda)--------------+ +-STARTSTATUS(cvda)--------+ +-TALENGTH(data-area)------+ +-TASKSTARTST(cvda)--------+ '-USECOUNT(data-area)------'
Conditions: END, ILLOGIC, INVREQ, NOTAUTH, PGMIDERR
This command is threadsafe.
For more information about the use of CVDAs, see CICS-value data areas (CVDAs).
The INQUIRE EXITPROGRAM command returns information about a global or task-related user exit. You identify the exit about which you are inquiring with the ENTRYNAME and EXITPROGRAM options.
You can also browse through the exit definitions in two different ways. To look at all of the global user exits defined at a particular exit point, you specify the exit point on the command that starts the browse, thus:
INQUIRE EXITPROGRAM EXIT(data-value) START
To look at all user exits, both global and task-related, you omit the EXIT option on the command that starts the browse. You can distinguish between the two types by looking at the NUMEXITS value, which is zero for a task-related exit and positive for a global exit.
On either type of browse, the sequence in which the exits are retrieved is the time order in which they were enabled.
CVDA values are:
CVDA values are:
For example, to inquire about the connection to DBCTL, use an EXITPROGRAM value of DFHDBAT and an ENTRYNAME value of DBCTL. To inquire about the connection to DB2, use an EXITPROGRAM value of DFHD2EX1, or DSN2EXT1 (DSN2EXT1 is still recognised for compatibility with earlier releases) , with an ENTRYNAME of DSNCSQL, or DSNCCMD.
CVDA values are:
UNKNOWN is returned for all subsequent calls for the remaining lifetime of the task. A new task is able to call the task-related user exit and get the required information.
If the task-related user exit is not enabled, the INQUIRE command returns PGMIDERR. This also indicates that CICS is not connected to the resource manager.
This value is returned only when the exit uses a global work area owned by another exit. Blanks are returned if it has allocated its own work area.
For global user exits and task-related user exits that are not enabled for SPI calls, returns blanks.
INQUIRE EXITPROGRAM(abcd) exit(XFCREQ)
If you omit EXIT(XFCREQ), you are inquiring about a task-related user exit. Because all global user exits are, by default, task-related user exits as well, NOSPI is returned.