Database query request (TYPE=DB)
You can use the Database Query request (DSPAPI FUNC=QUERY TYPE=DB) to retrieve information from the RECON concerning one or more registered databases.
This information includes the following database types:
- Full function
- Fast Path DEDB
- HALDB (returns information about the HALDB master and all of its partitions)
Optionally, you can request data set and area information. If you request this information, you can also request recovery-related information for the data set or area, including allocation, image copy, recovery, and reorganization information.
Subsections:
- Syntax for the TYPE=DB query request
- Parameters for the TYPE=DB query request
- Return and reason codes for the TYPE=DB query request
- Output for TYPE=DB query request
- Full function output
- DSECT of DSPAPQDB
- DSECT of DSPAPQSL
- Fast Path DEDB output
- DSECT of DSPAPQFD
- DSECT of DSPAPQAR
- DSECT of DSPAPQEL
- HALDB (master and all partitions) output
- DSECT of DSPAPQHB
- DSECT of DSPAPQHP
- DBDS output
- DSECT of DSPAPQDS
- Recovery Information (RCVINFO) output
- DSECT of DSPAPQRI
- DSECT of DSPAPQAL
- DSECT of DSPAPQIC
- DSECT of DSPAPQRV
- DSECT of DSPAPQRR
- Database not found output
- DSECT of DSPAPQNF
Syntax for the TYPE=DB query request
Parameters for the TYPE=DB query request
- name
- If used, begins in column 1.
- TYPE=DB
- Specifies that RECON information for one or more databases is requested.
- TOKEN=address | (2 - 12)
- Specifies the address of a 4-byte field that was returned on the FUNC=STARTDBRC request.
- DBNAME=symbol | symbol* | (2 - 12)
- Specifies the name of the database whose information is being queried. This
name can be the name of a full-function database, a Fast Path DEDB, or a
HALDB. You can use the wildcard keyword * (an asterisk) at the end of a name
to query databases whose names match the pattern. In this case, the asterisk
must be preceded by at least one alphabetic character.
You must specify a DBNAME or DBLIST if you do not specify LOC=FIRST.
- DBLIST=namelist | (2 - 12)
- Specifies the list of database names whose information is being queried.
Each name in the list can be the name of a Full Function database, a Fast
Path DEDB, or a HALDB.
The list consists of a header and one or more eight-character list entries. The header consists of a fullword containing the number of entries in the list. The name entries are left-aligned and are padded with blanks.
You must specify a DBNAME or DBLIST if you do not specify LOC=FIRST.
- DDN=ddname | (2 - 12) | NULL
- Specifies the DD name of the data set or area. An asterisk (*) can be
specified to return information about all DBDSs or areas for the database.
If a specific DD name is specified with DBLIST or a DBNAME that specifies a
HALDB, the specific DD name is ignored and treated as if DDN=* was
specified.
If you specify DDN=NULL, no DBDS or area information is returned. DDN=NULL is the default.
- LIST=(ALLOC | IC | RECOV | REORG) | ALL | LIST=NONE
- Specifies the type (or types) of supporting information to be included in
the query output for the specified DBDS or area.
If DDN is not specified, this information is returned for all DBDSs or areas in the database.
One or more of the specific values, separated by commas, can be included in the list: ALLOC (allocation records), IC (image copy records), RECOV (recovery records), or REORG (reorganization records). LIST=ALL specifies that all supporting information is requested.
To view information about HALDB online alter processing, specify LIST(REORG). The information about alter processing is included with the information about any other reorganization processes.
If you specify LIST=NONE, no supporting information is returned. LIST=NONE is the default.
- LOC=FIRST | NEXT | SPEC
- Specifies that the request is for either the specified, the first, or the
next database defined in the RECON.
DBNAME=dbname is required when you specify LOC=NEXT or LOC=SPEC, but it is not allowed for LOC=FIRST.
Databases are in alphanumeric order. The next database might not necessarily be of the same type as the database name specified in the DBNAME parameter. The value in the DBNAME parameter is used as the base of the search and does not need to be a name of a database registered in the RECON.
LOC=SPEC is the default.
- MF=S | L | M | E
- Specifies the macro form of the request.
- OUTPUT=output | (2 - 12)
- Specifies a field to receive a pointer to the first block of a possible
chain of database information blocks.
The output address is zero if no output was built. This can occur if nothing in the RECON satisfies the request or if an error occurs before any output could be built.
The storage for the output blocks is not pre-allocated by the caller. DBRC acquires storage from the specified subpool for these blocks. The caller must free this storage using the Buffer Release service (DSPAPI FUNC=RELBUF) and specify the returned output address.
- SUBPOOL= 0 | number
- Specifies the subpool number for the storage being obtained. If not specified, the default is the subpool specified by the FUNC=STARTDBRC request. Otherwise, subpool 0 is the default.
- RETCODE=returncode | (2-12)
- If specified as a symbol, specifies the label of a word of storage to receive the return code. If specified as a register, the register must contain the address of a word of storage to receive the return code. Regardless of whether RETCODE is specified, register 15 contains the return code.
- RSNCODE=reasoncode | (2-12)
- If specified as a symbol, the symbol must be the label of a word of storage to receive the reason code. If specified as a register, the register must contain the address of a word of storage to receive the reason code. Regardless of whether RSNCODE is specified, register 0 contains the reason code.
- VERSION=2.0 | number
- Specifies the version number of the parameter list to be generated by this
request.
To use the parameters associated with a version, you must specify the number of that version or a later version. If you specify an earlier version level, the parameter is not accepted by macro processing, and an error message is issued at assembly time. If parameters have a version dependency, the parameter descriptions with each request type identify the version number required.
Valid version numbers for the FUNC=QUERY TYPE=DB request are 1.0 and 2.0.
Return and reason codes for the TYPE=DB query request
| Code type | Return codes | Reason codes | Meaning |
|---|---|---|---|
| X'00000000' | X'00000000' | Request completed successfully. | |
| Partial success | X'00000004' | X'D8200001' | One or more databases in DBLIST is not registered in
the RECON. A DB not founddata block with an eyecatcher of DSPAPQNF is built for each database that was not found. The block is in the chain of blocks returned. |
| Warning | X'00000008' | X'D8220001' | No partitions are registered in RECON data set for the HALDB. No information blocks are returned. |
| X'00000008' | X'D8200001' | None of the databases in the DBLIST are registered in the RECON. No information blocks are returned. | |
| X'00000008' | X'D8220002' | The specified partition is not registered in RECON. No information blocks are returned. | |
| X'00000008' | X'D8200002' | The specified database is not registered in the RECON. No information blocks are returned. If the request specified LOC=NEXT, you have reached the end of the list of databases registered in the RECON. | |
| X'00000008' | X'D8200003' | No DBs with the specified wildcard name pattern are registered in RECON. No information blocks are returned. | |
| X'00000008' | X'D8210002' | The specified DBDS or Area is not registered in the RECON. No information blocks are returned. | |
| X'00000008' | X'D8220003' | A partition preceding the specified partition does not exist in the RECON data set. No information blocks are returned. | |
| X'00000008' | X'D8220004' | A partition following the specified partition does not exist in the RECON data set. No information blocks are returned. | |
| Severe error | X'0000000C' | X'C9000001' | Invalid TOKEN. The TOKEN block passed to the API is not recognized as a TOKEN created by a FUNC=STARTDBRC call. |
| X'0000000C' | X'C900000A' | The TCB address is not the same as the TCB address under which the STARTDBRC service was issued. | |
| X'0000000C' | X'D8200100' | Security error. SAF or the DBRC Command Authorization exit routine (DSPDCAX0) determined that the user is not authorized to perform the request. | |
| Storage error | X'00000028' | X'D8200001' | Error obtaining storage for IMSDB block. |
| X'00000028' | X'D8200002' | Error obtaining storage for HALDB block. | |
| X'00000028' | X'D8200003' | Error obtaining storage for FPDEDB block. | |
| X'00000028' | X'D8200004' | Error obtaining storage for DB not found block (DBNOTFND). | |
| X'00000028' | X'D8210001' | Error obtaining storage for DBDS block. | |
| X'00000028' | X'D8210002' | Error obtaining storage for AREA block. | |
| X'00000028' | X'D8210003' | Error obtaining storage for RCVINFO block. | |
| X'00000028' | X'D8210004' | Error obtaining storage for ALLOC block. | |
| X'00000028' | X'D8210005' | Error obtaining storage for IC block. | |
| X'00000028' | X'D8210006' | Error obtaining storage for REORG block. | |
| X'00000028' | X'D8210007' | Error obtaining storage for RECOV block. | |
| X'00000028' | X'D8220001' | Error obtaining storage for PART block. | |
| X'00000028' | X'D9100001' | An error occurred processing the request. DBRC will release storage that was obtained up to this point. Another error was encountered, however, during the attempt to release storage. | |
| Internal error | X'0000002C' | X'D8000001' | RECON open failure. |
| X'0000002C' | X'D8200001' | DB record locate failure processing DBLIST. | |
| X'0000002C' | X'D8200002' | DB record locate failure processing single database request. | |
| X'0000002C' | X'D8200003' | DB record locate failure processing database request using a wildcard. | |
| X'0000002C' | X'D82021xx' | Internal Query DBDS call returned RC=X'30' RSN=X'D82100xx', a parameter error. | |
| X'0000002C' | X'D82022xx' | Internal Query PART call returned RC=X'30' RSN=X'D82200xx', a parameter error. | |
| X'0000002C' | X'D8210001' | Failure locating the specified DBDS record. | |
| X'0000002C' | X'D8210002' | Failure locating the next DBDS record. | |
| X'0000002C' | X'D8210003' | Failure locating the first DBDS record. | |
| X'0000002C' | X'D8210004' | Failure locating the first Area AUTH record. | |
| X'0000002C' | X'D8210005' | Failure locating the first ALLOC record. | |
| X'0000002C' | X'D8210006' | Failure locating the next ALLOC record. | |
| X'0000002C' | X'D8210007' | Failure locating the first IC record. | |
| X'0000002C' | X'D8210008' | Failure locating the next IC record. | |
| X'0000002C' | X'D8210009' | Failure locating the first REORG record. | |
| X'0000002C' | X'D821000A' | Failure locating the next REORG record. | |
| X'0000002C' | X'D821000B' | Failure locating the first RECOV record. | |
| X'0000002C' | X'D821000C' | Failure locating the next RECOV record. | |
| X'0000002C' | X'D8220001' | Failure locating the first HALDB partition record. | |
| X'0000002C' | X'D8220002' | Failure attempting to locate the DB record associated with the HALDB partition being processed. | |
| X'0000002C' | X'D8220003' | Failure locating the next HALDB partition record. | |
| Parameter error | X'00000030' | X'C9000001' | The function (FUNC) specified in the parameter list passed to the API is invalid. |
| X'00000030' | X'C9000002' | Invalid TOKEN field address. The address of the field containing the API TOKEN failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'C9000003' | Invalid RETCODE field address. The address of the field to contain the API RETCODE failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'C9000004' | Invalid RSNCODE field address. The address of the field to contain the API RSNCODE failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'C9000005' | Invalid OUTPUT field address. The address of the field to contain the OUTPUT address failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'C9000008' | Invalid DBNAME or DBLIST address. The address of the field containing the DBNAME or DBLIST failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'C9000009' | Invalid DDN address. The address of the field containing the DDN failed validity checking. The address specifies storage not owned by the calling program. | |
| X'00000030' | X'D8000001' | Missing or invalid OUTPUT parameter. | |
| X'00000030' | X'D8200001' | LOC parameter is not allowed with DBLIST. | |
| X'00000030' | X'D8220001' | The DBNAME or PARTNAME is required. | |
| X'00000030' | X'D8000002' | Invalid value specified for TYPE parameter. | |
| X'00000030' | X'D8200002' | DBNAME parameter is not allowed with LOC=FIRST. | |
| X'00000030' | X'D8220002' | The LOC=FIRST | LAST is required with the DBNAME. | |
| X'00000030' | X'D8200003' | DBNAME parameter is required with LOC=NEXT. | |
| X'00000030' | X'D8220003' | The LOC=FIRST | LAST is not allowed with the PARTNAME. | |
| X'00000030' | X'D8200004' | DBNAME or DBLIST is required. | |
| X'00000030' | X'D8200005' | Count of databases in DBLIST is zero. | |
| X'00000030' | X'D8200006' | Database information is being requested for a HALDB partition. DBNAME or DBLIST contains a partition name. | |
| X'00000030' | X'D8200007' | DBNAME wildcard not allowed with LOC=NEXT | |
| X'00000030' | X'D8200100' | When using a wildcard, at least one alphabetic character must precede the asterisk. | |
| X'00000030' | X'D8200101' | When using a wildcard, the asterisk must be the last character. |
Output for TYPE=DB query request
The following figures illustrate the format of output from QUERY TYPE=DB requests. The sample DSECTs that follow the figures describe in detail the fields of the storage blocks and their relationship.
Full function output
The following shows the fields of the DSPAPQDB block.
The DBDS information is returned only if DDN is specified.
DSECT of DSPAPQDB
The following example describes the fields contained in the DSPAPQDB block shown in Figure 1.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 96 DSPAPQDB
0 (0) CHARACTER 8 APQDB_DBNAME Database name
8 (8) UNSIGNED 4 APQDB_SSLIST Offset to SS list (DSPAPQSL), zero
is no SS auth'd
12 (C) SIGNED 4 *(3) Reserved
24 (18) UNSIGNED 2 APQDB_IRCNT IC receive needed counter
26 (1A) BIT(8) 1 APQDB_AUFLAG Authorization flags
1... .... APQDB_BKFLG Backout needed flag
.1.. .... APQDB_PAFLG Prohibit authorization
..1. .... APQDB_RDFLG Read only SS auth
...1 .... APQDB_NONRV nonrecoverable
.... 1... APQDB_DBREORGI Reorg intent
.... .1.. APQDB_DBQUI Quiesce in progress
.... ..1. APQDB_DBQUIH Quiesce held
27 (1B) CHARACTER 5 APQDB_IRLMAU IRLMID of auth SS
32 (20) SIGNED 2 APQDB_RCVCTR Recovery needed count
34 (22) SIGNED 2 APQDB_ICCTR IC needed count
36 (24) SIGNED 2 APQDB_ICRECCTR IC recommended counter
38 (26) UNSIGNED 1 APQDB_SHRLVL Share level of DB
39 (27) UNSIGNED 1 APQDB_HELDAU Held auth state
1... .... APQDB_HAUBIT High order bit flag
40 (28) UNSIGNED 2 APQDB_DMBNUM Global DMB number
42 (2A) SIGNED 2 APQDB_SSNUM # of SS auth DB
44 (2C) UNSIGNED 2 APQDB_SSENTLEN Length of each SS entry
46 (2E) UNSIGNED 1 APQDB_CACCSS Access state for chg auth
47 (2F) UNSIGNED 1 APQDB_CANCDD Encode state for chg auth
48 (30) UNSIGNED 1 APQDB_CAHELD Held state for chg auth
49 (31) CHARACTER 1 APQDB_DBQTYPE Quiesce request type
50 (32) CHARACTER 2 * Reserved
52 (34) UNSIGNED 2 APQDB_EQECNT Total EQE count
54 (36) BIT(16) 2 APQDB_RSRFLG Flags
1... .... APQDB_RCVTRK Recovery level tracking
.1.. .... APQDB_TRKSPN Tracking is suspended
..1. .... APQDB_PURBIT Suspended by time
...1 .... APQDB_ICNDIS IC needed disabled option
56 (38) CHARACTER 8 APQDB_GSGNAME Global Service Group name
64 (40) UNSIGNED 4 APQDB_USID Last alloc USID
68 (44) UNSIGNED 4 APQDB_AUSID Last authorized USID
72 (48) UNSIGNED 4 APQDB_RUSID Last received USID
76 (4C) UNSIGNED 4 APQDB_HUSID Hardened by tracker USID
80 (50) UNSIGNED 4 APQDB_RNUSID Receive needed USID
84 (54) CHARACTER 8 APQDB_RECOVGRP Recovery Group name
92 (5C) CHARACTER 4 * Reserved
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQDB APQDB_EYECATCHER
Possible Quiesce request type values (APQDB_DBQTYPE)
===================================================================================
1 CHARACTER 0 APQDB_DBQTNQ No Quiesce
1 CHARACTER 1 APQDB_DBQTQAG NoHold Quiesce
1 CHARACTER 2 APQDB_DBQTQAH Quiesce and Hold
1 CHARACTER 5 APQDB_DBQTQHA Quiesce and HoldAllDSECT of DSPAPQSL
The following example describes the fields contained in the SS data (DSPAPQSL).
DSPAPQSL
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 16 DSPAPQSL
0 (0) CHARACTER 16 APQSL_SSINFO Subsystem list entry
0 (0) CHARACTER 8 APQSL_SSNAME Subsystem ID
8 (8) UNSIGNED 1 APQSL_ACCESS Access intent
9 (9) UNSIGNED 1 APQSL_NCDDST Encoded state
10 (A) BIT(8) 1 APQSL_SSFLGS Flags
1... .... APQSL_SSROLE 0 - Active SS, 1 - Tracking SS
.1.. .... APQSL_SSXRFC 1 - XRF Capable
..1. .... APQSL_SSBAT 1 - Batch SS
...1 .... APQSL_SSIC 1 - IC SS
11 (B) BIT(8) 1 * Reserved
12 (C) CHARACTER 4 APQSL_BKINFO Backout information
12 (C) SIGNED 2 APQSL_BKCTR Backout needed count
14 (E) SIGNED 2 APQSL_BKNUM Backout done count
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
Possible access intent values (apqsl_ACCESS)
====================================================================================
1 HEX 01 APQSL_ACCRO READ-GO
1 HEX 02 APQSL_ACCRD READ
1 HEX 03 APQSL_ACCUP UPDATE
1 HEX 04 APQSL_ACCEX EXCLUSIVEFast Path DEDB output
The area information is returned only if DDN is specified. Recovery information (RCVINFO) is only returned if the LIST parameter is specified.
DSECT of DSPAPQFD
The following example describes the fields contained in the DSPAPQFD and DSPAPQAR blocks shown in Figure 2.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ============================
0 (0) STRUCTURE 38 DSPAPQFD
0 (0) CHARACTER 8 APQFD_DBNAME Database name
8 (8) SIGNED 4 *(4) Reserved
24 (18) SIGNED 2 APQFD_RCVCTR Recovery Needed Counter
26 (1A) SIGNED 2 APQFD_ICCTR IC Needed Counter
28 (1C) SIGNED 2 APQFD_ICRECCTR IC Recommended Counter
30 (1E) UNSIGNED 2 APQFD_DMBNUM Global DMB number
32 (20) UNSIGNED 2 APQFD_EQECNT Total EEQE count
34 (22) SIGNED 2 APQFD_AUTHDAREAS Number of Areas authorized
36 (24) UNSIGNED 1 APQFD_SHRLVL Share Level
37 (25) BIT(8) 1 APQFD_FLAGS Flags
1... .... APQFD_PAFLG Prohibit authorization
.1.. .... APQFD_NONRV nonrecoverable
..1. .... APQFD_ICNDIS IC needed disabled option
...1 .... APQFD_USRRV user-recoverable (VERSION=1.01)
.... 1... APQFD_FULLSEG_DEFAULT Default full segment logging
setting for areas (VERSION=4.0)
38 (26) UNSIGNED 2 APQFD_ALTER# FP DEDB alter status
(VERSION=5.0)
40 (28) CHARACTER 8 APQFD_RANDOMIZER Randomizer name
(VERSION=5.01)
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ==============================
8 CHARACTER DSPAPQFD APQFD_EYECATCHERDSECT of DSPAPQAR
The following example describes the fields contained in the DSPAPQFD and DSPAPQAR blocks shown in Figure 2.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============= =============================
0 (0) STRUCTURE 196 DSPAPQAR
0 (0) CHARACTER 8 APQAR_DBNAME Database name
8 (8) CHARACTER 8 APQAR_AREANAME Area name
16 (10) UNSIGNED 4 APQAR_EEQELIST Offset to EEQE list
(DSPAPQEL), zero if no EEQEs
20 (14) UNSIGNED 4 APQAR_SSLIST Offset to SS list (DSPAPQSL),
zero if no SS auth'd
24 (18) UNSIGNED 4 APQAR_ADSLIST Offset to ADS list, zero if
none registered
28 (1C) SIGNED 4 * Reserved
32 (20) UNSIGNED 1 APQAR_SHRLVL Share level of DB
33 (21) UNSIGNED 1 APQAR_HELDAU Held auth state
1... .... APQAR_HAUBIT High order bit flag
34 (22) UNSIGNED 2 APQAR_DMBNUM Global DMB number
36 (24) SIGNED 2 APQAR_SSNUM # subsytems authd to Area
38 (26) UNSIGNED 2 APQAR_SSENTLEN Length of each SS entry
40 (28) UNSIGNED 1 APQAR_CACCSS Access state for CHG AUTH
41 (29) UNSIGNED 1 APQAR_CANCDD Encoded state for CHG AUTH
42 (2A) UNSIGNED 1 APQAR_CAHELD Held state for CHG AUTH
43 (2B) CHARACTER 5 APQAR_IRLMAU IRLMID of auth SS
48 (30) BIT(16) 2 APQAR_FLAGS
1... .... APQAR_RECYC REUSE image copies
.1.. .... APQAR_ICREC Image Copy Recommended
..1. .... APQAR_IC Image Copy Needed
...1 .... APQAR_ICNDIS IC needed disabled option 1 =
IC Needed Disabled
.... 1... APQAR_RECOV Recovery needed
.... .1.. APQAR_INPRO HSSP CIC in progress
.... ..1. APQAR_GT240 M/C FP GT240 area DEDB
.... ...1 APQAR_VSO VSO flag
49 (31) 1... .... APQAR_PREOP PREOPEN flag
.1.. .... APQAR_PRELD PRELOAD flag
..1. .... APQAR_LKASD VSO CF buffer lookaside
...1 .... APQAR_MAS VSO area resides in multi-area
CF structure
.... 1... APQAR_RRGAL REORG since last ALLOC, only
set if RSR-covered
.... .1.. APQAR_TSRAL TS recov since last ALLOC, only
set if RSR-covered
.... ..1. APQAR_FULLSEG Full segment logging in effect
(VERSION=4.0)
50 (32) BIT(8) 1 APQAR_RSRFLAGS Remote Site Recovery flags
1... .... APQAR_RCVTRK Recovery Level Tracking
.1.. .... APQAR_TRKSPN Tracking was suspended
..1. .... APQAR_PURBIT Suspended by time
...1 .... APQAR_RCVRQ Receive Required
51 (33) BIT(8) 1 APQAR_AUFLAG Authorization flags
1... .... APQAR_PAFLG Prohibit authorization
.1.. .... APQAR_NONRV nonrecoverable
..1. .... APQAR_USSRV User-recoverable (VERSION=1.01)
...1 .... APQAR_DBQUI Quiesce in progress
.... 1... APQAR_DBQUIH Quiesce held
.... .1.. APQAR_DBQUICMD HALDB/DEDB on command
.... ..1. APQAR SHADOW Shadow Area (VERSION=6.0)
52 (34) BIT(8) 1 APQAR_DSORG Data set organization
1... .... APQAR_VSAM 1 = VSAM, 0 = NON-VSAM
.1.. .... APQAR_INDEX 0 = Non-indexed (OSAM or ESDS),
1 = Indexed(ISAM or KSDS)
..11 1111 * Reserved - zeroesThe following example describes the fields contained in the DSPAPQFD and DSPAPQAR blocks shown in Figure 2.
53 (35) CHARACTER 1 APQAR_DBORG IMS DB organization
54 (36) CHARACTER 8 APQAR_GSGNAME GSG Name
62 (3E) CHARACTER 1 APQAR_DBQTYPE Quiesce request type
63 (3F) CHARACTER 1 * Reserved
64 (40) UNSIGNED 4 APQAR_USID Last ALLOC USID
68 (44) UNSIGNED 4 APQAR_AUSID Last authorized USID
72 (48) UNSIGNED 4 APQAR_RUSID Last received USID
76 (4C) UNSIGNED 4 APQAR_HUSID Hardened USID
80 (50) UNSIGNED 4 APQAR_RNUSID Receive needed USID
84 (54) CHARACTER 8 APQAR_RECOVGRP Recovery Group name
92 (5C) CHARACTER 8 APQAR_CAGRPNAME Change Accum group name
100 (64) UNSIGNED 2 APQAR_GENMX Max number of ICs that
may be predefined for this area
102 (66) UNSIGNED 2 APQAR_GENNO Number of available ICs for this area
104 (68) UNSIGNED 2 APQAR_USDIC Number of ICs used
106 (6A) SIGNED 2 APQAR_EEQECOUNT EEQE count
108 (6C) UNSIGNED 2 APQAR_EEQELENGTH EEQE entry length
110 (6E) UNSIGNED 1 APQAR_NOADS # of ADS in the area
111 (6F) UNSIGNED 1 APQAR_AVADS # of available ADS
112 (70) UNSIGNED 2 APQAR_ADSLENGTH ADS entry length
114 (72) CHARACTER 2 * Reserved
116 (74) CHARACTER 40 APQAR_JCL GENJCL members
116 (74) CHARACTER 8 APQAR_ICJCL Image copy member
124 (7C) CHARACTER 8 APQAR_OIJCL Online IC member
132 (84) CHARACTER 8 APQAR_RCJCL Recovery member
140 (8C) CHARACTER 8 APQAR_DFJCL DEFLTJCL member
148 (94) CHARACTER 8 APQAR_RVJCL Receive JCL member
156 (9C) UNSIGNED 2 APQAR_RTPRD IC retention period
158 (9E) UNSIGNED 2 APQAR_DSID IMS data set ID
160 (A0) UNSIGNED 4 APQAR_DSSN Data set sequence number
164 (A4) CHARACTER 16 APQAR_CFST1 VSO CF Structure 1
180 (B4) CHARACTER 16 APQAR_CFST2 VSO CF Structure 2
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============= ============================
0 (0) STRUCTURE 56 APQAR_ADSLT Area Data Set List
0 (0) CHARACTER 8 APQAR_ADSDD DDNAME of the ADS
8 (8) CHARACTER 44 APQAR_ADSDN DSN of the ADS
52 (34) BIT(8) 1 APQAR_ADSBT
1... .... APQAR_ADSAV Avail status of ADS
.1.. .... APQAR_ADSFM Format status of create util
..1. .... APQAR_ADSCP Copy status of create util
53 (35) CHARACTER 3 * Reserved
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ============================
8 CHARACTER DSPAPQAR APQAR_EYECATCHER
Possible Quiesce request type values (APQAR_DBQTYPE)
==================================================================================
1 CHARACTER 0 APQAR_DBQTNQ No Quiesce
1 CHARACTER 1 APQAR_DBQTQAG NoHold Quiesce
1 CHARACTER 2 APQAR_DBQTQAH Quiesce and Hold
1 CHARACTER 5 APQAR_DBQTQHA Quiesce and HoldAllDSECT of DSPAPQEL
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 13 DSPAPQEL
0 (0) CHARACTER 13 APQEL_EEQEENTRY EEQE descriptor entry
0 (0) BIT(8) 1 APQEL_EQEFG EEQE flags
1... .... APQEL_ERTL Toleration error
.1.. .... APQEL_ERRD Read error
..1. .... APQEL_ERWT Write error
...1 .... APQEL_ERUS DBRC user modified
.... 1... APQEL_ERPM DBRC permanent error
.... .1.. APQEL_INDT Indoubt EEQE
.... ..1. APQEL_CIIND Index CI indicator
1 (1) CHARACTER 4 APQEL_EQE EEQE
5 (5) CHARACTER 8 APQEL_SSID SSID which owns the EEQEHALDB (master and all partitions) output
The DBDS information is returned only if DDN is specified.
DSECT of DSPAPQHB
The following two examples describe the fields contained in the DSPAPQHB and DSPAPQHP blocks shown in Figure 3. Refer to Figure 4 for an illustration of the fields of the DBDS output.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 60 DSPAPQHB
0 (0) CHARACTER 8 APQHB_DBNAME HALDB name
8 (8) SIGNED 4 *(4) Reserved
24 (18) BIT(8) 1 APQHB_FLAGS Flags
1... .... APQHB_NONRV nonrecoverable
.1.. .... APQHB_ICNDIS IC needed disabled
..1. .... APQHB_OLRCAP HALDB is OLR capable
...1 .... APQHB_OSAM8G HALDB OSAM is 8GB addressability
25 (19) BIT(8) 1 APQHB_ORG DB organization
1... .... APQHB_PSINDEX PSINDEX DB
.1.. .... APQHB_PHIDAM PHIDAM DB
..1. .... APQHB_PHDAM PHDAM DB
...1 .... APQHB_OSAM OSAM DB
.... 1111 * Reserved
26 (1A) UNSIGNED 1 APQHB_SHRLVL Share level
27 (1B) UNSIGNED 1 APQHB_DSGCNT # DS Group members
28 (1C) UNSIGNED 2 APQHB_DMBNUM Global DMB number
30 (1E) UNSIGNED 2 APQHB_PARTID Current Partition ID
32 (20) SIGNED 2 APQHB_PART# Number of parts in HALDB
34 (22) UNSIGNED 2 APQHB_VERSION# Version number
36 (24) CHARACTER 8 APQHB_PSNAME Name of Part Sel Routine
44 (2C) CHARACTER 8 APQHB_GSGNAME GSG name
52 (34) CHARACTER 8 APQHB_RECOVGRP Recovery Group name
60 (3C) UNSIGNED 2 APQHB_ALTER# The total number of partitions
to be altered in an online
HALDB database
62 (3E) UNSIGNED 2 APQHB_ALTCMP# The number of partitions that
an active alter operation has
completed at the time the
query call was processed
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQHB APQHB_EYECATCHER
DSECT of DSPAPQHP
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 192 DSPAPQHP
0 (0) CHARACTER 8 APQHP_HALDBNAME HALDB name
8 (8) CHARACTER 8 APQHP_PARTNAME Partition name
16 (10) UNSIGNED 4 APQHP_SSLIST Offset to SS list (DSPAPQSL),
zero if no SS auth'd
20 (14) UNSIGNED 4 APQHP_KEYSTRING Offset to KEYSTRING
(apqhp_PString), zero is no
key/string
24 (18) UNSIGNED 4 APQHP_DSGINFOOFFSET Offset to data set group
information
28 (1C) SIGNED 4 APQHP_ALTERINFOOFFSET Offset of HALDB Alter
information structure,
APQHP_ALTERINFO, if present.
Value is 0 if not present.
32 (20) CHARACTER 44 *
32 (20) CHARACTER 37 APQHP_DSNBASE Base Partition DSN
76 (4C) CHARACTER 18 APQHP_HDAM PHDAM fields
76 (4C) CHARACTER 8 APQHP_RMNAME Randomizing module name
84 (54) SIGNED 4 APQHP_RBN Max relative block number
88 (58) SIGNED 4 APQHP_BYTES Max # of bytes
92 (5C) UNSIGNED 2 APQHP_ANCHR # of root anchor points
94 (5E) UNSIGNED 1 APQHP_FBFF Free block frequency factor
95 (5F) UNSIGNED 1 APQHP_FSPF Free space percentage factor
96 (60) UNSIGNED 2 APQHP_PARTID Partition ID
98 (62) SIGNED 2 APQHP_PSTLN Length of Part Key/String,
apqhp_PString
100 (64) UNSIGNED 2 APQHP_DSGINFOLEN
Length of each
aphp_DSGinfo entry
102 (66) UNSIGNED 1 APQHP_DSGCNT DSG count
103 (67) BIT(8) 1 APQHP_FLAGS Flags
1... .... APQHP_PINIT Partition must be initialized
.1.. .... APQHP_ORDBDS 0=A-J/1=M-V DBDS active
..1. .... APQHP_OLRON OLR active
...1 .... APQHP_DISAB Partition Disabled
.... 1... APQHP_MVDBDS 1 = M-V DBDS exist
.... .1.. APQHP_OLRCAP Partition is OLR capable
.... ..1. APQHP_OLRREL 1 = RELEASE OLR OWNER
.... ...1 APQHP_OSAM8G 8GB OSAM addressability
============================================================================
If the Partitioned DB uses high keys, that is, no Partition
Selection routine, the next two fields are used to sort the
partitions in key sequence.
============================================================================
104 (68) CHARACTER 8 APQHP_PREV DDN of previous partition
112 (70) CHARACTER 8 APQHP_NEXT DDN of next partition
120 (78) CHARACTER 8 APQHP_OLRIMS Owning IMS for OLR
128 (80) UNSIGNED 2 APQHP_IRCNT IC receive needed counter
130 (82) BIT(8) 1 APQHP_AUFLAG Authorization flags
1... .... APQHP_BKFLG Backout needed
.1.. .... APQHP_PAFLG Prohibit authorization
..1. .... APQHP_RDFLG Read only SS auth
...1 .... APQHP_NONRV nonrecoverable
.... 1... APQHP_DBREORGI Reorg intent
.... .1.. APQHP_DBQUI Quiesce in progress
.... ..1. APQHP_DBQUIH Quiesce held
.... ...1 APQAR_DBQUICMD HALDB/DEDB on command
131 (83) CHARACTER 5 APQHP_IRLMAU IRLM ID of auth SS
136 (88) SIGNED 2 APQHP_RCVCTR Recovery needed count
138 (8A) SIGNED 2 APQHP_ICCTR IC needed count
140 (8C) UNSIGNED 1 APQHP_SHRLVL Share level of DB
141 (8D) UNSIGNED 1 APQHP_HELDAU Held auth state
1... .... APQHP_HAUBIT High order bit flag
142 (8E) UNSIGNED 2 APQHP_DMBNUM Global DMB number
144 (90) SIGNED 2 APQHP_SSNUM # of SS auth DB
146 (92) UNSIGNED 2 APQHP_SSENTLEN Length of each SS entry
148 (94) UNSIGNED 1 APQHP_CACCSS Access state for chg auth
149 (95) UNSIGNED 1 APQHP_CANCDD Encode state for chg auth
150 (96) UNSIGNED 1 APQHP_CAHELD Held state for chg auth
151 (97) CHARACTER 1 APQHP_DBQTYPE Quiesce request type
152 (98) UNSIGNED 2 APQHP_EQECNT Total EQE count
154 (9A) BIT(16) 2 APQHP_RSRFLG Flags
1... .... APQHP_RCVTRK Only recov level trackng
.1.. .... APQHP_TRKSPN Tracking is suspended
..1. .... APQHP_PURBIT Suspended by time
...1 .... APQHP_ICNDIS IC needed disabled option
.... 1... APQHP_NOHKEY High key required
.... .1.. APQHP_ALTER Partition being altered
.... ..1. APQHP_ALTCMP Partition alter completed;
partition ready for online
change
156 (9C) CHARACTER 8 APQHP_GSGNAME GSG name
164 (A4) UNSIGNED 4 APQHP_USID Last alloc USID
168 (A8) UNSIGNED 4 APQHP_AUSID Last authorized USID
172 (AC) UNSIGNED 4 APQHP_RUSID Last received USID
176 (B0) UNSIGNED 4 APQHP_HUSID Hardened by tracker USID
180 (B4) UNSIGNED 4 APQHP_RNUSID Receive needed USID
184 (B8) SIGNED 2 APQHP_ICRECCTR IC Recommended Counter
186 (BA) UNSIGNED 2 APQHP_VERSION# Version number
188 (BC) UNSIGNED 1 APQHP_OLRACTHARDCTR
OLR curs active count
189 (BD) UNSIGNED 1 APQHP_OLRINACTHARDCTR
OLR curs inact count
190 (BE) UNSIGNED 2 APQHP_REORG# Partition reorg #
192 (C0) CHARACTER 8 APQHP_OLRBytes OLR Bytes moved
200 (C8) CHARACTER 8 APQHP_OLRSegs OLR Segments moved
208 (D0) CHARACTER 4 APQHP_OLRRoots OLR Root Segments
212 (D4) UNSIGNED 2 APQHP_ALTERINFOLEN Length of each
apqhp_AlterInfo entry
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 2 APQHP_DSGINFO Data set group information
0 (0) UNSIGNED 2 APQHP_BLKSZ DS block size, OSAM only
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE * APQHP_PSTRING Partition Key/String
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 2 APQHP_ALTERINFO DB Alter information
Structure present only when an
alter operation is in progress
0 (0) UNSIGNED 2 APQHP_ALTERSZ If alter changes block or CI
sizes, ALTERSZ contains the
OSAM block size or VSAM CI size
for the output data sets of an
alter operation
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= ================ ===============================
8 CHARACTER DSPAPQHP APQHP_EYECATCHER
Possible Quiesce request type values (APQHP_DBQTYPE)
===================================================================================
1 CHARACTER 0 APQHP_DBQTNQ No Quiesce
1 CHARACTER 1 APQHP_DBQTQAG NoHold Quiesce
1 CHARACTER 2 APQHP_DBQTQAH Quiesce and Hold
1 CHARACTER 5 APQHP_DBQTQHA Quiesce and HoldAllDBDS output
Recovery information (RCVINFO) is returned only if the LIST parameter is specified.
DSECT of DSPAPQDS
The following example and DSECT of DSPAPQEL describe the fields contained in the DSPAPQDS block shown in Figure 4. Refer to Figure 5 for an illustration of the Recovery Information output fields.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 160 DSPAPQDS
0 (0) CHARACTER 8 APQDS_DBNAME Database name
8 (8) CHARACTER 8 APQDS_DDNAME DD name
16 (10) UNSIGNED 4 APQDS_EEQELIST Offset to EEQE list
(DSPAPQEL), zero if no EEQEs
20 (14) SIGNED 4 *(3) Reserved
32 (20) CHARACTER 44 APQDS_DSN Data set name
76 (4C) UNSIGNED 2 APQDS_RTPRD IC retention period
78 (4E) UNSIGNED 2 APQDS_DSID Data set ID number
80 (50) UNSIGNED 4 APQDS_DSSN Data set sequence number
84 (54) UNSIGNED 4 APQDS_RUSID Recovered-to USID(trkr)
88 (58) BIT(8) 1 APQDS_FLAGS BINARY ZEROS
1... .... APQDS_RECYC REUSE image copies
.1.. .... APQDS_ICREC Image Copy Recommended
..1. .... APQDS_RCVRQ Receive required
...1 .... APQDS_IC Image Copy Needed
.... 1... APQDS_RECOV Recovery Needed
.... .1.. APQDS_NONRV nonrecoverable
89 (59) BIT(8) 1 APQDS_DSORG Data set organization
1... .... APQDS_VSAM 1 = VSAM, 0 = NON-VSAM
.1.. .... APQDS_INDEX 0 = Non-indexed (OSAM or ESDS),
1 = Indexed(ISAM or KSDS)
..11 1111 * Reserved - zeroes
90 (5A) CHARACTER 1 APQDS_DBORG IMS DB organization
91 (5B) UNSIGNED 1 * Reserved
92 (5C) UNSIGNED 2 APQDS_GENMX Max number of ICs that may be
predefined for this area
94 (5E) UNSIGNED 2 APQDS_AVAILIC#
Number of available ICs for
this area
96 (60) UNSIGNED 2 APQDS_USEDIC# Number of ICs used
98 (62) SIGNED 2 APQDS_EEQECOUNT
EEQE count
100 (64) UNSIGNED 2 APQDS_EEQELENGTH
EEQE entry length
102 (66) BIT(8) 1 APQDS_FLG1 Flags
1... .... APQDS_RRGAL REORG since last ALLOC, only
set if RSR-covered
.1.. .... APQDS_TSRAL TS recov since last ALLOC, only
set if RSR-covered
103 (67) BIT(8) 1 APQDS_FLG2 DBDS type flags
1... .... APQDS_PART TYPEPART record
.1.. .... APQDS_PDATA TYPEPART subtype DATA
..1. .... APQDS_PILE TYPEPART subtype ILE
...1 .... APQDS_PINDX TYPEPART subtype Index
104 (68) CHARACTER 8 APQDS_CAGRPNAME
Change Accum group name
112 (70) CHARACTER 40 APQDS_JCL GENJCL members
112 (70) CHARACTER 8 APQDS_ICJCL Image copy member
120 (78) CHARACTER 8 APQDS_OIJCL Online IC member
128 (80) CHARACTER 8 APQDS_RCJCL Recovery member
136 (88) CHARACTER 8 APQDS_DFJCL DEFLTJCL member
144 (90) CHARACTER 8 APQDS_RVJCL Receive JCL member
152 (98) CHARACTER 8 APQDS_ODDN OLR partner DBDS
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= ================ ===============================
8 CHARACTER DSPAPQDS APQDS_EYECATCHERRecovery Information (RCVINFO) output
Recovery information (RCVINFO) is returned only if the LIST parameter is specified. The pointers are zero if either the specific information does not exist or it was not requested.
DSECT of DSPAPQRI
The following DSECT example describes the fields that are contained in the DSPAPQRI block as shown in Figure 5.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 32 DSPAPQRI
0 (0) CHARACTER 8 APQRI_DBNAME Database name
8 (8) CHARACTER 8 *
8 (8) CHARACTER 8 APQRI_DDNAME DD name
8 (8) CHARACTER 8 APQRI_AREANAME Area name
16 (10) ADDRESS 4 APQRI_ALLOCPTR ptr to ALLOC chain
20 (14) ADDRESS 4 APQRI_ICPTR ptr to IC chain
24 (18) ADDRESS 4 APQRI_RECOVPTR ptr to RECOV chain
28 (1C) ADDRESS 4 APQRI_REORGPTR ptr to REORG chain
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQRI APQRI_EYECATCHERDSECT of DSPAPQAL
The following DSECT example describes the fields that are contained in the DSPAPQAL block as shown in Figure 5.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 88 DSPAPQAL
0 (0) CHARACTER 8 APQAL_DBNAME Database name
8 (8) CHARACTER 8 *
8 (8) CHARACTER 8 APQAL_DDNAME DD name or
8 (8) CHARACTER 8 APQAL_AREANAME Area name
16 (10) CHARACTER 12 APQAL_ALLOCTM Allocation time
28 (1C) CHARACTER 12 APQAL_DALTM Deallocation time
40 (28) CHARACTER 12 APQAL_STRTM Log start time
52 (34) UNSIGNED 4 APQAL_DSSN Field for DSSN value
56 (38) UNSIGNED 4 APQAL_USID Update set identifier
60 (3C) CHARACTER 8 APQAL_ALRID LRID of begin-upd rec
68 (44) CHARACTER 8 APQAL_DLRID LRID of end-upd rec
76 (4C) CHARACTER 8 APQAL_SLRID Last LRID applied if suspended
84 (54) BIT(8) 1 APQAL_FLAGS Flags
1... .... APQAL_TSUSP Tracking is suspended
.1.. .... APQAL_NAPPL No records applied
..1. .... APQAL_CICPT Fuzzy ic purge time
...1 .... APQAL_DBQUI Quiesce caused deallocation
85 (55) CHARACTER 3 * Reserved
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQAL APQAL_EYECATCHERDSECT of DSPAPQIC
The following DSECT example describes the fields that are contained in the DSPAPQIC block as shown in Figure 5.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== =============================
0 (0) STRUCTURE 64 DSPAPQIC
0 (0) CHARACTER 8 APQIC_DBNAME Database name
8 (8) CHARACTER 8 *
8 (8) CHARACTER 8 APQIC_DDNAME DD name or
8 (8) CHARACTER 8 APQIC_AREANAME Area name
16 (10) CHARACTER 12 APQIC_STARTIME IC start time, packed decimal
28 (1C) CHARACTER 12 APQIC_STOPTIME IC stop time, packed decimal
40 (28) BIT(8) 1 APQIC_TYPE IMAGE COPY TYPE
1... .... APQIC_BATCH BATCH
.1.. .... APQIC_CIC CONCURRENT
..1. .... APQIC_USERIC USER IMAGE COPY
...1 .... APQIC_ONLINE ONLINE
.... 1... APQIC_SMSIC SMS IC w/ DB exclusive
.... .1.. APQIC_SMSCC SMS IC w/ DB shared
.... ..1. APQIC_SMSOF FastRep IC w/ DB exclusive
(VERSION=2.00)
.... ..1 APQIC_SMSON FastRep IC w/ DB shared
(VERSION=2.00)
41 (29) BIT(8) 1 APQIC_STATUS IC status flags
1... .... APQIC_AVAIL Available IC
.1.. .... APQIC_IC1 Image Copy 1 exists
..1. .... APQIC_IC2 Image Copy 2 exists
...1 .... APQIC_ERR1 Error on image 1
.... 1... APQIC_ERR2 Error on image 2
.... .1.. APQIC_EMP2 Image 2 defined and unused
42 (2A) BIT(8) 1 APQIC_FLAGS
1... .... APQIC_HSINP HSSP CIC in progress
.1.. .... APQIC_CAT Catalogued IC (HSSP)
43 (2B) CHARACTER 1 APQIC_MoreTYPEs More Image Copy types
1... .... APQIC_UserCIC User Concurrent Image Copy
(VERSION=2.0)
44 (2C) CHARACTER 2 *
44 (2C) UNSIGNED 2 APQIC_OFF1 Offset to image 1 data
44 (2C) UNSIGNED 2 APQIC_OFFU Offset to user IC data
46 (2E) UNSIGNED 2 APQIC_OFF2 Offset to image 2 data
48 (30) UNSIGNED 4 APQIC_CNT12 Record count
52 (34) UNSIGNED 4 APQIC_USID Update set ID
56 (38) CHARACTER 2 *
56 (38) UNSIGNED 2 APQIC_LEN12 Length of image 1/2 data
56 (38) UNSIGNED 2 APQIC_LENU Length of user IC data
58 (3A) CHARACTER 6 * Reserved
64 (40) UNSIGNED 2 APQIC_OFFUD Offset to user data (Version=4.0)
66 (42) UNSIGNED 2 APQIC_LENUD Length of user data (Version=4.0)
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ==========================
0 (0) STRUCTURE 64 APQIC_IC12 Data for image 1 or 2
0 (0) CHARACTER 44 APQIC_DSN12 Data set name
44 (2C) UNSIGNED 2 APQIC_FILE File sequence number
46 (2E) CHARACTER 8 APQIC_RUT12 Unit device type
54 (36) UNSIGNED 2 APQIC_VOLCT # of volumes predefined
56 (38) UNSIGNED 2 APQIC_VOLUS # of volumes used
58 (3A) UNSIGNED 2 APQIC_VOLLISTLEN Length of each volume list
entry in apqic_VOLS
60 (3C) UNSIGNED 4 APQIC_VOLLISTOFFSET Offset to volume list
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) CHARACTER 6 APQIC_VOLS List of VOLSERs
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 80 APQIC_USER Data for user IC
0 (0) CHARACTER 80 APQIC_UDATA User supplied data
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
1 DECIMAL 255 APQIC_MAXV max # volumes
8 CHARACTER DSPAPQIC APQIC_EYECATCHERDSECT of DSPAPQRV
The following DSECT example describes the fields that are contained in the DSPAPQRV block as shown in Figure 5.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ==============================
0 (0) STRUCTURE 49 DSPAPQRV
0 (0) CHARACTER 8 APQRV_DBNAME Database name
8 (8) CHARACTER 8 *
8 (8) CHARACTER 8 APQRV_DDNAME DD name or
8 (8) CHARACTER 8 APQRV_AREANAME Area name
16 (10) CHARACTER 12 APQRV_RUNTIME The time at which the DBDS was
recovered
28 (1C) CHARACTER 12 APQRV_ENDTIME Partial recovery only, the time
to which the DBDS was restored
40 (28) UNSIGNED 4 APQRV_FUSID First undone USID
44 (2C) UNSIGNED 4 APQRV_LUSID Last undone USID
48 (30) BIT(8) 1 APQRV_FLAGS Flags
1... .... APQRV_PITR Point In Time Recovery
.1.. .... 1 APQRV_EXTCM External command (Version=4.0)
49 (31) UNSIGNED 1 * Reserved
50 (32) UNSIGNED 2 APQRV_OFFUD Offset to user data (Version=4.0)
52 (34) UNSIGNED 2 APQRV_LENUD Length of user data (Version=4.0)
54 (33) UNSIGNED 2 APQRV_PREORG Prior reorg number (Version=4.0)
56 (36) UNSIGNED 2 APQRV_NREORG New reorg number (Version=4.0)
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 80 APQRV_USER Data for user data
0 (0) CHARACTER 80 APQRV_UDATA User supplied data (VERSION=4.0)
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQRV APQRV_EYECATCHERDSECT of DSPAPQRR
The following DSECT example describes the fields that are contained in the DSPAPQRR block as shown in Figure 5.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 60 DSPAPQRR
0 (0) CHARACTER 8 APQRR_DBNAME Database name
8 (8) CHARACTER 8 *
8 (8) CHARACTER 8 APQRR_DDNAME DD name or
8 (8) CHARACTER 8 APQRR_AREANAME Area name
16 (10) CHARACTER 12 APQRR_RUNTIME The time at which the DBDS was
reorganized
28 (1C) CHARACTER 12 APQRR_STOPTIME Stoptime of online reorg
40 (28) BIT(8) 1 APQRR_FLAGS
1... .... APQRR_ONL 1=ONLINE/0=OFFLINE reorg
.1.. .... APQRR_RECOV 1=May be used for recovery
..1. .... APQRR_ALTER 1=HALDB structure altered by
an online reorganization
41 (29) CHARACTER 3 * Reserved
44 (2C) UNSIGNED 4 APQRR_USID Associated USID
48 (30) CHARACTER 12 APQRR_PITR Stoptime moved - PITR
60 (3C) UNSIGNED 4 APQRR_PRAPs Total number of RAPs processed
64 (40) UNSIGNED 4 APQRR_Roots Total number of roots processed
68 (44) UNSIGNED 2 APQRR_OFFUD Offset to user data (VERSION=4.0)
70 (46) UNSIGNED 2 APQRR_LENUD Length of user data (VERSION=4.0)
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 80 APQRR_USER Data for user data
0 (0) CHARACTER 80 APQRR_UDATA User supplied data (VERSION=4.0)
CONSTANTS
LEN TYPE VALUE NAME DESCRIPTION
===== ========= ================= =============== ===============================
8 CHARACTER DSPAPQRR APQRR_EYECATCHERDatabase not found output
This output block is returned when some of the databases specified in the DBLIST block could not be found in the RECON. One block is returned for each database that could not be found. The database name is included in the data area of this block.
When a database is not found, the macro call receives a return code of four (RC=4). If none of the databases in the list are found (RC=8), no output blocks are returned.
DSECT of DSPAPQNF
The following example describes the fields contained in the DSPAPQNF block shown in Figure 6.
OFFSET OFFSET
DECIMAL HEX TYPE LENGTH NAME (DIM) DESCRIPTION
======== ======== ========= ======== ============== ===============================
0 (0) STRUCTURE 8 DSPAPQNF
0 (0) CHARACTER 8 APQNF_DBNAME DB name