The format of the open list information is common across many of the open list APIs. The open list APIs return data for use by the process open list APIs. The process open list APIs are located in the Miscellaneous part whereas the open list APIs can be found in the applicable sections. For example, the Open List of Messages (QGYOLMSG) API is located in the Messages part.

The following shows the format of the list information parameter in the open list APIs. For a detailed description of each field, see the Field Descriptions.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Total records
4	4	BINARY(4)	Records returned
8	8	CHAR(4)	Request handle
12	C	BINARY(4)	Record length
16	10	CHAR(1)	Information complete indicator
17	11	CHAR(13)	Date and time created
30	1E	CHAR(1)	List status indicator
31	1F	CHAR(1)	Reserved
32	20	BINARY(4)	Length of information returned
36	24	BINARY(4)	First record in receiver variable
40	28	CHAR(40)	Reserved

Field Descriptions

Date and time created. The date and time when the list was created. The 13 characters are:

1

Century, where 0 indicates years 19xx and 1 indicates years 20xx.

2-7

The date, in YYMMDD (year, month, day) format.

8-13

The time of day, in HHMMSS (hours, minutes, seconds) format.

First record in receiver variable. The number of the first record returned in the receiver variable.

Information complete indicator. Whether all requested information has been supplied. Possible values follow:

C

Complete and accurate information. All of the requested records have been returned in the receiver variable.

I

Incomplete information. An interruption causes the receiver variable to contain incomplete information.

P

Partial and accurate information. Partial information is returned when the receiver variable is full and not all of the records requested are returned.

Length of information returned. The size, in bytes, of the information that is returned in the receiver variable.

List status indicator. The status of building the list.

Possible values follow:

0

The building of the list is pending.

1

The list is in the process of being built.

2

The list has been completely built.

3

An error occurred when building the list. The next call to the Get List Entries (QGYGTLE) API will cause the error to be signaled to the caller of the QGYGTLE API.

4

The list is primed and ready to be built. The list will be built asynchronously by a server job, but the server job has not necessarily started building the list yet.

Record length. The length of each record of information returned. For variable length records, this value is set to zero. For variable length records, you can obtain the length of individual records from the records themselves.

Records returned. The number of records that are returned in the receiver variable. This number is the smallest of the following values:

• The number of records that will fit into the receiver variable.
• The number of records in the list.
• The number of records that are requested.

Request handle. The handle of the request that can be used for subsequent requests of information from the list. The handle is valid until the Close List (QGYCLST) API is called to close the list, or until the job ends.

Note: This field should be treated as a hexadecimal field. It should not be converted from one CCSID to another, for example, EBCDIC to ASCII, because doing so could result in an unusable value.

Reserved. An ignored field.

Total records. The total number of records available in the list.