Home
Handle status
For handle status, the following information is always returned for each queue that satisfies the selection criteria, except where indicated:
- Queue name
- Type of information returned (TYPE parameter)
- On platforms other than z/OS, user identifier (USERID parameter) – not returned for APPLTYPE(SYSTEM)
- On platforms other than z/OS, process ID (PID parameter)
- On platforms other than z/OS, thread ID (TID parameter)
- On platforms other than z/OS, application tag (APPLTAG parameter)
- Application type (APPLTYPE parameter)
- On platforms other than z/OS, whether handle is providing input access (INPUT parameter)
- On platforms other than z/OS, whether handle is providing output access (OUTPUT parameter)
- On platforms other than z/OS, whether handle is providing browse access (BROWSE parameter)
- On platforms other than z/OS, whether handle is providing inquire access (INQUIRE parameter)
- On platforms other than z/OS, whether handle is providing set access (SET parameter)
The following parameters can be specified for TYPE(HANDLE) to request additional information for each queue. If a parameter that is not relevant is specified for the queue, operating environment, or type of status information requested, that parameter is ignored.
- APPLTAG
- A string containing the tag of the application connected to the queue manager. It is one of the following:
- z/OS batch job name
- TSO USERID
- CICS APPLID
- IMS™ region name
- Channel initiator job name
- i5/OS job name
- UNIX process
- Windows process
This consists of the full program path and executable file name. If it is more than 28 characters long, only the last 28 characters will be shown.
- Internal queue manager process name
Application name represents the name of the process or job that has connected to the queue manager. In the instance that this process or job is connected via a channel, the application name represents the remote process or job rather than the local channel process or job name.
- APPLTYPE
- A string indicating the type of the application that is connected to the queue manager. It is one of the following:
- BATCH
- Application using a batch connection
- RRSBATCH
- RRS-coordinated application using a batch connection
- CICS
- CICS transaction
- IMS
- IMS transaction
- CHINIT
- Channel initiator
- SYSTEM
- Queue manager
- USER
- A user application
- ASID
- A 4-character address-space identifier of the application identified by APPLTAG. It distinguishes duplicate values of APPLTAG.
This parameter is returned only when the queue manager owning the queue is running on z/OS, and the APPLTYPE parameter does not have the value SYSTEM.
- BROWSE
- Indicates whether the handle is providing browse access to the queue. The value is one of the following:
- YES
- The handle is providing browse access.
- NO
- The handle is not providing browse access.
- CHANNEL
- The name of the channel that owns the handle. If there is no channel associated with the handle, this parameter is blank.
This parameter is returned only when the handle belongs to the channel initiator.
- CONNAME
- The connection name associated with the channel that owns the handle. If there is no channel associated with the handle, this parameter is blank.
This parameter is returned only when the handle belongs to the channel initiator.
- HSTATE
- Whether an API call is in progress.
Possible values are:
- ACTIVE
- An API call from a connection is currently in progress for this object. For a queue, this condition can arise when an MQGET WAIT call is in progress.
If there is an MQGET SIGNAL outstanding, then this does not mean, by itself, that the handle is active.
- INACTIVE
- No API call from a connection is currently in progress for this object. For a queue, this condition can arise when no MQGET WAIT call is in progress.
- INPUT
- Indicates whether the handle is providing input access to the queue. The value is one of the following:
- SHARED
- The handle is providing shared-input access.
- EXCL
- The handle is providing exclusive-input access.
- NO
- The handle is not providing input access.
- INQUIRE
- Indicates whether the handle is providing inquire access to the queue. The value is one of the following:
- YES
- The handle is providing inquire access.
- NO
- The handle is not providing inquire access.
- OUTPUT
- Indicates whether the handle is providing output access to the queue. The value is one of the following:
- YES
- The handle is providing output access.
- NO
- The handle is not providing output access.
- PID
- Number specifying the process identifier of the application that has opened the specified queue.
This parameter is not valid on z/OS.
- PSBNAME
- The 8-character name of the program specification block (PSB) associated with the running IMS transaction. We can use the PSBNAME and PSTID to purge the transaction using IMS commands. It is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value IMS.
- PSTID
- The 4-character IMS program specification table (PST) region identifier for the connected IMS region. It is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value IMS.
- QMURID
- The queue manager unit of recovery identifier. On z/OS, this is a 6–byte log RBA, displayed as 12 hexadecimal characters. On platforms other than z/OS, this is an 8–byte transaction identifier, displayed as m.n where m and n are the decimal representation of the first and last 4 bytes of the transaction identifier.
We can use QMURID as a filter keyword. On z/OS, specify the filter value as a hexadecimal string. On platforms other than z/OS, specify the filter value as a pair of decimal numbers separated by a period (.). We can only use the EQ, NE, GT, LT, GE, or LE filter operators.
- QSGDISP
- Indicates the disposition of the queue. It is valid on z/OS only. The value is one of the following:
- QMGR
- The object was defined with QSGDISP(QMGR).
- COPY
- The object was defined with QSGDISP(COPY).
- SHARED
- The object was defined with QSGDISP(SHARED).
We cannot use QSGDISP as a filter keyword.
- SET
- Indicates whether the handle is providing set access to the queue. The value is one of the following:
- YES
- The handle is providing set access.
- NO
- The handle is not providing set access.
- TASKNO
- A 7-digit CICS task number. This number can be used in the CICS command "CEMT SET TASK(taskno) PURGE" to end the CICS task. This parameter is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value CICS.
- TID
- Number specifying the thread identifier within the application process that has opened the specified queue.
This parameter is not valid on z/OS.
- TRANSID
- A 4-character CICS transaction identifier. This parameter is valid on z/OS only.
This parameter is returned only when the APPLTYPE parameter has the value CICS.
- URID
- The external unit of recovery identifier associated with the connection. It is the recovery identifier known in the external syncpoint coordinator. Its format is determined by the value of URTYPE.
We cannot use URID as a filter keyword.
- URTYPE
- The type of unit of recovery as seen by the queue manager. It is one of the following:
URTYPE identifies the EXTURID type and not the type of the transaction coordinator. When URTYPE is QMGR, the associated identifier is in QMURID (and not URID).
- USERID
- The user identifier associated with the handle.
This parameter is not returned when APPLTYPE has the value SYSTEM.
Parent topic:
Parameter descriptions
sc12290_
Home