gtpo1m1sOperations

ZBROW DISPLAY-Display Information about a Collection or Its Contents

Use this command to display information about a collection and to display the contents of a collection.

Requirements and Restrictions

Format




COLlection
displays the names and values of all the attributes of the specified collection that are set by the user, such as data length, key length, collection type, and so on.

colname
is the assigned name of the collection.

ALL
displays all the collection names for the specified data store (DS).

PRT
sends results to the printer instead of displaying the values.

DSname-dsname
specifies the data store with the collections that will be displayed, where dsname is the name of the data store.

ELEment
displays the specified element of the collection. The data is displayed in hexadecimal format and in EBCDIC translation. If you do not specify additional parameters with this parameter, the first 16 bytes of the first element are displayed.

ENTry
has the same functionality as the ELEMENT parameter and is provided for compatibility. Use the ELEMENT parameter instead of the ENTRY parameter.

INDEX-index
displays the element of the collection corresponding to the index specified, where index is a 1-based long value. For array and sequence collections, 1 represents the first element; for logs and keyed logs, 1 represents the oldest element. For other collection types, the index will represent the element at the specified cursor position. The order established by the cursor is collection dependent and can vary.

VALue
displays the element of the collection whose key corresponds to the specified value. This is used for key bag, key set, key sorted bag, key sorted set, sorted bag, and sorted set collections.

decval
is a character string.

X%hexval
is a hexadecimal value.

USEQual
displays the element of the collection corresponding to the values saved from a previously entered ZBROW QUALIFY command. The data will be displayed starting at the position specified by the RSA parameter for a length indicated by the DLEN parameter. If DLEN was not specified, the data will be displayed for a length equal to the length of the DATA value. If DATA was not specified, the first 16 bytes will be displayed.

RSA-displacement.length
displays the relative starting address in the specified element for a specified length, where displacement.length is the hexadecimal displacement and length of the element to display. The display will show data rounded down and up to the nearest X'10' bytes. If the displacement plus the length is greater than the entry size, the display will end when the end of the entry is reached. The maximum displacement length is X'FFFF' bytes.

FA
displays TPF collection support (TPFCS) information about the record.

farf
is the 8- or 16-digit hexadecimal file address in file address reference format (FARF).

RRN
displays the directory entry for a specific relative record number (RRN) of a collection.

rrn
is the hexadecimal RRN value whose directory entry will be displayed.

Additional Information

None.

Examples

In some of the following examples, the ZBROW QUALIFY command is shown only to make the examples more complete.

In the following example, information about collections that belong to the BANK1_DS data store are dumped.

+--------------------------------------------------------------------------------+
|User:    ZBROW QUAL SET DS-BANK1_DS                                             |
|                                                                                |
|System:  BROW0607I 08.36.31 QUALIFICATION PROCESSING COMPLETED                  |
|                                                                                |
|User:    ZBROW DISP COL ALL DS-BANK1_DS PRT                                     |
|                                                                                |
|System:  BROW0602I 08.38.57 BROWSER QUALIFIED FOR DSNAME BANK1_DS               |
|         BROW0410I 08.38.57 BROWSE OF COLLECTION COMPLETED                      |
+--------------------------------------------------------------------------------+

The BANK1_DS inventory collection is displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW DISP COL DS_INVENTORY                                             |
|                                                                                |
|System: BROW0602I 10.11.13 BROWSER QUALIFIED FOR DSNAME BANK1_DS                |
|        BROW0405I 17.56.40 COLLECTION DISPLAY                                   |
|         PID - 0202FC16AF8601A4C6C1D74BC4E24040                                 |
|               1802F4971802F4980000000000000000                                 |
|            COLLECTION CLASS NAME - OIDinventory                                |
|            COLLECTION TYPE NAME - DICTIONARY                                   |
|            COLLECTION CREATE TIME - AF8601A4B4CFA004                           |
|            COLLECTION RECOUP INDEX NAME -  *NONE*                              |
|            NUMBER ENTRIES - 00000126  MAXIMUM RECORD LENGTH - 00000038         |
|            KEY LENGTH  - 00000010                                              |
|            RESIDENCY TYPE - EXTENDED                                           |
|            NUMBER OF RECORDS USED 0000000D                                     |
|        END OF DISPLAY                                                          |
|        BROW0410I 17.56.41 BROWSE OF COLLECTION COMPLETED                       |
+--------------------------------------------------------------------------------+

An entry in the BANK1_DS inventory collection is displayed in the following example.

+--------------------------------------------------------------------------------+
|User:    ZBROW DISP ELEMENT DS_INVENTORY                                        |
|                                                                                |
|System:  BROW0602I 08.38.57 BROWSER QUALIFIED FOR DSNAME BANK1_DS               |
|         BROW0408I 08.38.57 COLLECTION ELEMENT DISPLAY                          |
|         CLASS ID 0000007C SEQ CTR 00000000 LGH 00000050                        |
|         00000000- F5F0F4F0 F0F1F1F0 5C5C5C5C 5C5CC1C2 50400110 ******AB        |
|         END OF DISPLAY - ZEROED LINES NOT DISPLAYED                            |
|         BROW0410I 08.38.57 BROWSE OF COLLECTION COMPLETED                      |
+--------------------------------------------------------------------------------+

The contents of the DS_USER_DICT values are displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW DISP ELEMENT DS_USER_DICT VAL-X%D9C5C3D6E4D76DE3D7C6D2C5E86D RSA-0.|
|                                                                                |
|System: BROW0602I 16.23.38 BROWSER QUALIFIED FOR DSNAME TPFDB                   |
|        BROW0408I 16.23.38 COLLECTION ELEMENT DISPLAY                           |
|        CLASS ID 0000007D SEQ CTR 00000000 LGH 00000040                         |
|        00000000- 00000000 00000000 00000000 40404040 ........ ....             |
|        00000010- 000001F4 000005AD 00000064 000000C8 ...4.... .......H         |
|        00000020- 0002FC16 AF098124 E3D7C6C4 C2404040 ......a. TPFDB            |
|        00000030- 1802DD83 1802DD84 00000000 00000000 ...c...d ........         |
|        END OF DISPLAY - ZEROED LINES NOT DISPLAYED                             |
|        BROW0410I 16.23.38 BROWSE OF COLLECTION COMPLETED                       |
+--------------------------------------------------------------------------------+

The element inside collection ARRAYL1 that corresponds to the existing qualification is displayed in the following example.

+--------------------------------------------------------------------------------+
|User:   ZBROW QUAL DISP ALL                                                     |
|                                                                                |
|System: CSMP0097I 12.19.28 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0606I 12.19.28 BROWSER QUALIFICATION DISPLAY                        |
|        TERM ADDRESS - 10000                                                    |
|        DSNAME       - TO2SVTDS                                                 |
|        DATA LENGTH  - 40                                                       |
|        RSA          - 0                                                        |
|        BROW0607I 12.19.28 QUALIFICATION PROCESSING COMPLETED+                  |
|                                                                                |
|User:   ZBROW DISPLAY ELEMENT ARRAYL1 USEQUAL                                   |
|                                                                                |
|System: CSMP0097I 12.19.43 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0602I 12.19.43 BROWSER QUALIFIED FOR DSNAME TO2SVTDS                |
|        BROW0408I 12.19.43 COLLECTION ELEMENT DISPLAY                           |
|        CLASS ID 0000007D SEQ CTR 00000001 LGH 0000003C                         |
|         00000000- E2E8E2E3 C5D440E3 C5E2E340 C4C1E3C1 SYSTEM T EST DATA        |
|         00000010- 40F0F0F0 F0F0F040 40404040 40C1D9D9  000000       ARR        |
|         00000020- C1E8D3F1 40404040 40404040 40404040 AYL1                     |
|         00000030- C5D5C4D6 C6C4C1E3 C1000000          ENDOFDAT A...            |
|        END OF DISPLAY - ZEROED LINES NOT DISPLAYED+                            |
|        CSMP0097I 12.19.43 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0410I 12.19.43 BROWSE OF COLLECTION COMPLETED+                      |
|                                                                                |
|User:   ZBROW QUAL DISP ALL                                                     |
|                                                                                |
|System: CSMP0097I 12.22.07 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0606I 12.22.07 BROWSER QUALIFICATION DISPLAY                        |
|        TERM ADDRESS - 10000                                                    |
|        DSNAME       - TO2SVTDS                                                 |
|        DATA         - NEWDATA                                                  |
|        RSA          - 1D                                                       |
|        BROW0607I 12.22.07 QUALIFICATION PROCESSING COMPLETED+                  |
|                                                                                |
|User:   ZBROW DISPLAY ELEMENT ARRAYL1 USEQUAL                                   |
|                                                                                |
|System: CSMP0097I 12.21.41 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0602I 12.21.41 BROWSER QUALIFIED FOR DSNAME TO2SVTDS                |
|        BROW0408I 12.21.41 COLLECTION ELEMENT DISPLAY                           |
|        CLASS ID 0000007D SEQ CTR 00000001 LGH 0000003C                         |
|         0000001D- C1D9D9C1 E8D3F1                     ARRAYL1                  |
|        END OF DISPLAY - ZEROED LINES NOT DISPLAYED+                            |
|        CSMP0097I 12.21.41 CPU-B SS-BSS  SSU-HPN  IS-01                         |
|        BROW0410I 12.21.41 BROWSE OF COLLECTION COMPLETED+                      |
|                      	                                                         |
+--------------------------------------------------------------------------------+

In the previous examples, CLASS ID and SEQ CTR are internally used fields. LGH is the element size.

The following examples display information about the record whose file address is FA 18009D1C. All of the possible fields that can be shown in the file address display are listed here in alphabetic order, but are not shown in the display:

 ASSOCIATED COLLECTION PID - pid 
indicates the persistent identifier (PID) of the owning collection.

 ASSOCIATED COLLECTION PREVIOUSLY DELETED 
indicates the collection associated with this record was previously deleted by TPFCS.

 COLLECTION DSNAME dsname 
indicates the data store of the collection associated with this record, where dsname is the data store name.

 CONTROL RECORD 
indicates that the specified record is a control record. This message will also be displayed for overflow records for the first control record associated with the collection.
Note:
For compact-resident collections, this message will be displayed even if the specified record contains a structure object.

 DATA RECORD WITH classname OBJECT. RRN - n 
indicates that this is a data record, where classname indicates the class name of the object used to package the collection data elements and n is the integer value, in decimal, of the relative record number (RRN).

 DELPAGE RECORD 
indicates that the specified record contains a DELPAGE object because TPFCS has deleted the record. The associated collection can still be active.

 DIRECTORY ENTRY directory_entry shadowed 
displays the contents of the directory entry that TPFCS uses to locate the specified record when processing its associated collection. The hexadecimal contents of the entry are displayed in place of directory_entry. If the directory entry indicates that the specified record is shadowed, the text SHADOWED will be displayed in place of the variable shadowed immediately after the directory entry contents. If the directory entry does not indicate that the specified record is shadowed, nothing is displayed immediately after the directory entry contents.

Directory entries are shown in standard or expanded format. Standard format indicates that file addresses are stored in 4-byte fields and expanded format indicates that file addresses are stored in 8-byte fields.

 DIRECTORY RECORD WITH classname OBJECT 
indicates that this is a directory record, where classname indicates the class name of the object used to package the directory entries.

 ERROR READING OWNING CONTROL RECORD 
indicates an input/output (I/O) error occurred when attempting to read the owning control record.

 ERROR READING RECORD 
indicates the file address that is supplied appears valid, but an I/O error occurred when attempting to read the record to obtain additional information.

 FILE ADDRESS SPECIFIED NOT VALID 
indicates the file address specified was not a valid TPF FARF file address.

 FIXED FILE RECORD 
indicates that the file address is a TPF fixed file record. TPFCS only uses pool file records to represent specific collections.

 KEY RECORD WITH classname OBJECT. RRN - n 
indicates that this is a key record, where classname indicates the class name of the object used to package the key entries and n is the integer value, in decimal, of the relative record number RRN.

 OWNING CONTROL RECORD FA - farf1 
indicates the file address of the owning control record, where farf1 is an 8- or 16-digit hexadecimal FARF address.

 OWNING CONTROL RECORD FA NOT VALID 
indicates the file address of the owning control record is not a valid TPF FARF address.

 OWNING CONTROL RECORD NOT VALID 
indicates that the control record was read successfully, but is not valid for one of the following reasons:

 OWNER ID FORMAT NOT VALID 
indicates the format of the owner identifier (ID) field in the record is not valid and, therefore, the file address of the owning control record contained in this field may be corrupt. As a result, any additional information about the owning control record or the collection associated with the file address you specified may be inaccurate.

 POOL FILE RECORD 
indicates that the file address is a valid pool file record.

 POOL FILE RECORD CANNOT BELONG TO TPFCS 
indicates the specified record cannot be used by TPFCS to represent a collection because it is not the correct pool record size used by TPFCS.

 RELPAGE RECORD 
indicates that the specified record contains a RELPAGE object because TPFCS has scheduled the record to be deleted. The associated collection can still be active.

 STRUCTURE RECORD WITH classname OBJECT 
indicates that this is the structure record of an extended-resident collection, where classname indicates the class name of the structure object.

 UNKNOWN RECORD TYPE 
indicates that it is not possible to determine how the record is used by TPFCS because the record does not contain familiar object header information at the correct displacement.

The following example shows the directory entry in standard format:

+--------------------------------------------------------------------------------+
|User:    ZBROW DISP FA 18009D1C                                                 |
|                                                                                |
|System:  BROW0701I 07.20.54 FILE ADDRESS INFORMATION DISPLAY FOR FA 18009D1C    |
|               POOL FILE RECORD                                                 |
|               DATA RECORD WITH NDXDATAPAGE OBJECT.  RRN -        3             |
|               OWNING CONTROL RECORD FA -  18009D15                             |
|               ASSOCIATED COLLECTION PID - 0001FC16B0BAE322E3D7C6C4C2404040     |
|                                           18009D15000000000000000000000000     |
|               COLLECTION DSNAME TPFDB                                          |
|               DIRECTORY ENTRY 0000000018009D1C0000000000000000                 |
|         END OF DISPLAY                                                         |
|                                                                                |
|         BROW0702I 07.20.54 BROWSE OF FILE ATTRIBUTES COMPLETED                 |
+--------------------------------------------------------------------------------+

The following example shows the directory entry in expanded format:

+--------------------------------------------------------------------------------+
|User:    ZBROW DISP FA 18009D1C                                                 |
|                                                                                |
|System:  BROW0701I 07.20.54 FILE ADDRESS INFORMATION DISPLAY FOR FA 18009D1C    |
|               POOL FILE RECORD                                                 |
|               DATA RECORD WITH NDXDATAPAGE OBJECT.  RRN -        3             |
|               OWNING CONTROL RECORD FA -  18009D15                             |
|               ASSOCIATED COLLECTION PID - 0001FC16B0BAE322E3D7C6C4C2404040     |
|                                           18009D15000000000000000000000000     |
|               COLLECTION DSNAME TPFDB                                          |
|               DIRECTORY ENTRY 000080000000000018009D1C000000000000000000000000 |
|         END OF DISPLAY                                                         |
|                                                                                |
|         BROW0702I 07.20.54 BROWSE OF FILE ATTRIBUTES COMPLETED                 |
+--------------------------------------------------------------------------------+

The examples that follow show the directory entry for RRN E7D. The following example shows the directory entry in standard format:

+--------------------------------------------------------------------------------+
|User:     ZBROW DISP RRN DS_INVENTORY E7D                                       |
|                                                                                |
|System:   BROW0602I 10.11.26 BROWSER QUALIFIED FOR DSNAME FAP.BSS               |
|          BROW0703I 10.11.26 DIRECTORY - 00000040 1800D2DF 1800D2E0 00000000    |
|          BROW0410I 10.11.26 BROWSE OF COLLECTION COMPLETED                     |
+--------------------------------------------------------------------------------+

The following example shows the directory entry in expanded format:

+--------------------------------------------------------------------------------+
|User:     ZBROW DISP RRN DS_INVENTORY E7D                                       |
|                                                                                |
|System:   BROW0602I 10.11.26 BROWSER QUALIFIED FOR DSNAME FAP.BSS               |
|          BROW0703I 10.11.26 DIRECTORY - 00008040 00000000 1800D2DF 00000000    |
|                                         1800D2E0 00000000                      |
|          BROW0410I 10.11.26 BROWSE OF COLLECTION COMPLETED                     |
+--------------------------------------------------------------------------------+

Related Information