| 1 | Returned override information | Output | Char(*) |
| 2 | Length of override information | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | File name | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
The Retrieve File Override Information (QDMRTVFO) API returns the name of the file, library, member and final type of override that result from processing TOFILE or MBR overrides for the user specified file name. Overrides will be processed in the following sequence:
None.
The structure in which to return information for file overrides processed. It can be smaller than the format requested as long as the next parameter, length of override information, specifies the length correctly. When this variable is smaller than the format, the API returns only the data the variable can hold.
Variable that contains the length of the user provided output area. The minimum length is 8 bytes. If you specify a length that is longer than the returned override information, the results will be unpredictable.
The content and format of the information returned for each file. The possible format names are:
| OVRL0100 | File override information. |
For more information, see OVRL0100 Format
The name of the file to return override information.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | File name used |
| 18 | 12 | CHAR(10) | Library name used |
| 28 | 1C | CHAR(10) | Member name used |
| 38 | 26 | CHAR(10) | Final override type |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
File name used. The file name that results from processing file overrides for the user provided file name. This field will be set to blanks in the following cases:
Final override type. This field will contain the final
override type applied to the file.
This field will be set to the final type of override command specified as
follows:
| BSC | Binary synchronous communications (BSC) |
| CMN | Communications |
| DB | Database |
| DDM | Distributed data management |
| DKT | Diskette |
| DSP | Display |
| ICF | Intersystem communications function |
| MXD | Mixed |
| PRT | Printer |
| SAV | Save |
| TAP | Tape |
This field will be set to blanks in the following cases:
Library name used. The library name which results from processing file overrides for the user provided file name including the values *LIBL and *CURLIB.
This field will be set to blanks in the following cases:
This will be set to *LIBL if the file name is being overridden and library name is not.
Member name used. The member name which results from processing file overrides for the user provided file name including the values *FIRST, *LAST and *ALL. This field will be set to *FIRST when the final override type is Data Base and the member is not being overridden.
This field will be set to blanks in the following cases:
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| Top | Database and File APIs | APIs by category |