This topic shows the generic user space layout. Format 0100 shows the format for an original program model (OPM) layout. Format 0300 shows the format for an Integrated Language Environment® (ILE) model layout. The fields are described in detail after the table.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(64) | User area |
| 64 | 40 | BINARY(4) | Size of generic header |
| 68 | 44 | CHAR(4) | Structure's release and level |
| 72 | 48 | CHAR(8) | Format name |
| 80 | 50 | CHAR(10) | API used |
| 90 | 5A | CHAR(13) | Date and time created |
| 103 | 67 | CHAR(1) | Information status |
| 104 | 68 | BINARY(4) | Size of user space used |
| 108 | 6C | BINARY(4) | Offset to input parameter section |
| 112 | 70 | BINARY(4) | Size of input parameter section |
| 116 | 74 | BINARY(4) | Offset to header section |
| 120 | 78 | BINARY(4) | Size of header section |
| 124 | 7C | BINARY(4) | Offset to list data section |
| 128 | 80 | BINARY(4) | Size of list data section |
| 132 | 84 | BINARY(4) | Number of list entries |
| 136 | 88 | BINARY(4) | Size of each entry |
| 140 | 8C | BINARY(4) | CCSID of data in the list entries |
| 144 | 90 | CHAR(2) | Country or region ID |
| 146 | 92 | CHAR(3) | Language ID |
| 149 | 95 | CHAR(1) | Subsetted list indicator |
| 150 | 96 | CHAR(42) | Reserved |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from the 0100 format | |
| 192 | C0 | CHAR(256) | API entry point name |
| 448 | 1C0 | CHAR(128) | Reserved |
This topic describes the fields returned in further detail. Field descriptions are in alphabetical order.
API entry point name. The name of the ILE bindable API entry point that generated the list.
API used. For format 0100, this is the name of the original program model (OPM) API that generated the list. For format 0300, this is a reserved field. See the API entry point name field for the API used.
CCSID of the data in the list entries. The coded character set ID for data in the list entries. If 0, then the data is not associated with a specific CCSID and should be treated as hexadecimal data.
Country or region ID. The country or region identifier of the data written to the user space.
Date and time created. The date and time when the list was created. The 13 characters are:
| Value | Description |
|---|---|
| 1 | Century, where 0 indicates years 19 xx and 1 indicates years 20 xx. |
| 2-7 | The date, in YYMMDD (year, month, day) format. |
| 8-13 | The time of day, in HHMMSS (hours, minutes, seconds) format. |
Format name. The name of the format for the list data section.
Information status. Whether or not the information is complete and accurate. Possible values are:
| Value | Description |
|---|---|
| C | Complete and accurate. |
| I | Incomplete. The information you received is not accurate or complete. |
| P | Partial but accurate. The information you received is accurate, but the API had more information to return than the user space could hold. See List sections for more information about partial lists. |
Language ID. The language identifier of the data written to the user space.
Number of list entries. The number of fixed-length entries in the list data section.
Offset to (all) section. The byte offset from the beginning of the user space to the start of the section.
Reserved. An ignored field.
Size of each entry. The size of each list data section entry, in bytes. All entries are the same size. For formats that return variable length records, this is zero.
Size of generic header. The size of the generic header, in bytes. This does not include the size of the user area; refer to General data structure for a diagram showing the user area.
Size of header section. The size of the header section, in bytes.
Size of input parameter section. The size of the input parameter section, in bytes.
Size of list data section. The size of the list data section, in bytes. For formats that return variable length records, this is zero.
Size of user space used. The combined size of the user area, generic header, input parameter section, header section, and list data section, in bytes. This determines what is changed in the user space.
Structure's release and level. The release and level of the generic header format for this list. The value of this field is 0100 for generic header format 0100 and 0300 for generic header format 0300. List APIs put this value into the user space.
Subsetted list indicator. A flag that indicates if the data selected from the list API can be stored in that format.
| Value | Description |
|---|---|
| 0 | List is not subsetted; all of the information can be stored in the format. |
| 1 | List is subsetted. For example, integrated file system names may be longer than the available area in the format. See the API specific documentation for detail. |
User area. An area within the user space that is provided for the caller to use to communicate system programmer-related information between applications that use the user space.