List Record Formats (QUSLRCD) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Qualified file name | Input | Char(20) |
| 4 | Override processing | Input | Char(1) |
Optional Parameter Group:
| 5 | Error code | I/O | Char(*) |
Service Program Name: QUSLRCD
Default Public Authority: *USE
Threadsafe: No
The List Record Formats (QUSLRCD) API generates a list of record format information contained within the specified file and places the list in a specified user space. The created list replaces any existing information in the user space.
You can use the QUSLRCD API with database file types, such as *PF, *LF, and *DDMF, and device file types, such as *DSPF, *TAPF, *DKTF, *PRTF, *SAVF, and *ICFF.
Authorities and Locks
- User Space Authority
- *CHANGE
- User Space Library Authority
- *EXECUTE
- File Library Authority
- *USE
- File Authority
- *OBJOPR
- User Space Lock
- *EXCLRD
- File Lock
- *SHRRD
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The name of the user space that is to receive the generated list, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name. You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Format name
- INPUT; CHAR(8)
The format of the information returned. The possible format names are:
RCDL0100 Record format name only. RCDL0200 Record format name and additional information. This format requires more system paging and takes longer to produce than the RCDL0100 format. RCDL0300 Record format name and device file information. This format requires more system paging and takes longer to produce than the RCDL0100 format. This format is only applicable to device file types.
For more information, see RCDL0100 List Data Section, RCDL0200 List Data Section or RCDL0300 List Data Section
- Qualified file name
- INPUT; CHAR(20)
The name of the file whose record format names are placed in the list, and the library in which it is located. The first 10 characters contain the file name, and the second 10 characters contain the library name. You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Override processing
- INPUT; CHAR(1)
Whether overrides are to be processed. The possible values are:
0 No override processing 1 Override processing
Optional Parameter
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
Format of the Generated List
The record format list consists of:
- A user area
- A generic header
- An input parameter section
- A header section
- A list data section
For details about the user area and generic header, see User spaces. For details about the other items, see the following sections. For descriptions of each field, see Field Descriptions.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header as a displacement to the next list entry. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see Examples: APIs and exit programs.
Input Parameter Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name |
| 10 | A | CHAR(10) | User space library name |
| 20 | 14 | CHAR(8) | Format name |
| 28 | 1C | CHAR(10) | File name specified |
| 38 | 26 | CHAR(10) | File library name specified |
| 48 | 30 | CHAR(1) | Override processing |
Header Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | File name used |
| 10 | A | CHAR(10) | File library name used |
| 20 | 14 | CHAR(10) | File type |
| 30 | 1E | CHAR(50) | File text description |
| 80 | 50 | BINARY(4) | File text description CCSID |
| 84 | 54 | CHAR (13) | File creation date |
RCDL0100 List Data Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Record format name |
RCDL0200 List Data Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Record format name |
| 10 | A | CHAR(13) | Record format ID |
| 23 | 17 | CHAR(1) | Reserved |
| 24 | 18 | BINARY(4) | Record length |
| 28 | 1C | BINARY(4) | Number of fields |
| 32 | 20 | CHAR(50) | Record text description |
| 82 | 52 | CHAR(2) | Reserved |
| 84 | 54 | BINARY(4) | Record text description CCSID |
RCDL0300 List Data Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Record format name |
| 10 | A | CHAR(2) | Lowest response indicator |
| 12 | C | BINARY(4) | Buffer size |
| 16 | 10 | CHAR(20) | Record format type |
| 36 | 24 | CHAR(1) | Starting line number |
| 37 | 25 | CHAR(1) | Separate indicator area present |
Field Descriptions
Buffer size. The user buffer size.
Record text description CCSID. Record text description CCSID.
| 0 | There is no record text description. |
| 1-65,535 | The CCSID for the record text description. |
File creation date. The date of the file in the format CYYMMDDHHMMSS as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
| HH | Hour |
| MM | Minute |
| SS | Second |
File library name specified. The name of the file library specified in the call to the API.
File library name used. The name of the library that contained the file. If the library requested was *LIBL or *CURLIB, this field contains the name of the library where the system found the file.
File name specified. The name of the file specified in the call to the API.
File name used. The name of the file whose record formats are listed. If override processing was requested, this is the actual file.
File text description. The text description of the file.
File text description CCSID. Record text description CCSID.
| 0 | There is no file text description. |
| 1-65,535 | The CCSID for the file text description. |
File type. The type of file found:
| BSCF | Binary synchronous communications (BSC) file |
| CMNF | Communications file |
| DSPF | Display file |
| DDMF | Distributed data management file |
| DKTF | Diskette file |
| ICFF | Intersystem communications function file |
| LF | Logical file |
| MXDF | Mixed file |
| PF | Physical file |
| PRTF | Printer file |
| SAVF | Save file |
| TAPF | Tape file |
Lowest response indicator. The lowest response indicator in the file. The possible values are:
| 00 | No response indicators in the file or response indicators are not applicable |
| 01-99 | Response indicator |
Number of fields. The number of fields contained in this record format. You can use the List Field Description (QUSLFLD) API to retrieve field information about this record.
Override processing. Whether overrides are to be processed. The possible values are:
| 0 | No override processing |
| 1 | Override processing |
Record format name. The name of the format used to list records. The possible values are:
| RCDL0100 | Record format name only |
| RCDL0200 | Record format name and additional information |
| RCDL0300 | Record format name and device information |
Record format name. The name of this record format.
Record length. The length of this record format.
Record text description. The text description of this record format.
Reserved. An ignored field.
Record format type. The type of this record format. The possible values are:
| Normal | Normal record |
| SFL | Subfile record |
| SFLMSGRCD | Subfile message record |
| SFLCTL | Subfile control record |
| USRDFN | User-defined record |
| WINDOW | Window record |
Separate indicator area present. The existence of a separate indicator area. The possible values are:
| 0 | No indicator area |
| 1 | Indicator area |
Starting line number. A starting line number was specified for this record format. The possible values are:
| 0 | Starting line number is not specified. |
| 1 | Starting line number is specified. |
User space library name. The name of the library that contains the user space that is to receive the generated list.
User space name. The name of the user space that is to receive the generated list.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C20 E | Error found by program &1. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C22 E | Cannot get information about file &1. |
| CPF3C25 E | Value &1 for file override parameter is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9800 E | All CPF98xx messages could be signaled. xx is from 01 to FF. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V1R3
[ Back to top | Database and File APIs | APIs by category ]