INQUIRE VTAM

Retrieve information about the connection between CICS and VTAM.

Read syntax diagramSkip visual syntax diagramINQUIRE VTAM
 
>>-INQUIRE VTAM------------------------------------------------->
 
   .---------------------------------------------.
   V                                             |
>----+-----------------------------------------+-+-------------><
     +-GRNAME(data-area)-----------------------+
     +-GRSTATUS(cvda)--------------------------+
     +-OPENSTATUS(cvda)------------------------+
     '-+-PSDINTERVAL(data-area)--------------+-'
       '-| hours |--| minutes |--| seconds |-'
 
hours:
 
|--PSDINTHRS(data-area)-----------------------------------------|
 
minutes:
 
|--PSDINTMINS(data-area)----------------------------------------|
 
seconds:
 
|--PSDINTSECS(data-area)----------------------------------------|
 

Conditions: INVREQ, NOTAUTH

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE VTAM command returns information about type and state of the connection between VTAM and your CICS system.

Options

GRNAME(data-area)
returns the 8-character generic resource group name under which this CICS region requests registration to VTAM, if it is using the generic resources facility of VTAM. Blanks are returned if the system was initialized without a request for registration.
GRSTATUS(cvda)
returns a CVDA value indicating the status of generic resource registration. All of the values except NOTAPPLIC indicate that CICS has been initialized to use the generic resource function (that is, that a nonblank GRNAME value was specified). CVDA values are:
DEREGERROR
Deregistration was attempted but was unsuccessful, and there has been no attempt to reregister.
DEREGISTERED
Deregistration was successfully accomplished.
NOTAPPLIC
CICS is not using the generic resource feature; GRNAME is not set or is set to blanks.
REGERROR
Registration was attempted but was unsuccessful, and there has been no attempt to deregister.
REGISTERED
Registration was successful and there has been no attempt to deregister.
UNAVAILABLE
VTAM does not support the generic resource function.
UNREGISTERED
CICS is using the generic resource function but no attempt, as yet, has been made to register.
OPENSTATUS(cvda)
returns a CVDA value indicating the status of the connection between CICS and VTAM. CVDA values are:
CLOSED
The connection between CICS and VTAM has not yet been established or has been terminated.
CLOSEFAILED
The connection is open but is not usable because a previous request to close the connection failed. You should retry the close request.
CLOSING
The connection between CICS and VTAM is in the process of closing.
FORCECLOSING
The connection between CICS and VTAM is in the process of closing following a SET VTAM FORCECLOSE command.
IMMCLOSING
The connection between CICS and VTAM is in the process of closing following a SET VTAM IMMCLOSE command.
OPEN
There is a connection between CICS and VTAM.
PSDINTERVAL(data-area)
returns the persistent session delay (PSD) interval, which is the length of time that sessions are held in recovery-pending state after a CICS failure. (See the PSDINT system initialization parameter in the CICS® System Definition Guide for more information about this option.) There are two formats for the PSD interval:
  • A composite (packed decimal format 0hhmmss+, 4 bytes long), which you obtain by using the PSDINTERVAL option.
  • Separate hours, minutes, and seconds, which you obtain by specifying the PSDINTHRS, PSDINTMINS, and PSDINTSECS options.
(A value of zero means that sessions are not held after a failure, and may indicate that the VTAM in use is not at the level that supports persistent sessions.)
PSDINTHRS(data-area)
returns the hours component of the PSD interval, in fullword binary form (see the PSDINTERVAL option).
PSDINTMINS(data-area)
returns the minutes component of the PSD interval, in fullword binary form (see the PSDINTERVAL option).
PSDINTSECS(data-area)
returns the seconds component of the PSD interval, in fullword binary form (see the PSDINTERVAL option).

Conditions

INVREQ
RESP2 values:
1
VTAM is not present in the system.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
[[ Contents Previous Page | Next Page Index ]]