| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
The Retrieve Language Identifiers (QLGRTVLI) API retrieves a list of language identifiers and their descriptions.
None.
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested, provided you specify the length of receiver variable parameter correctly. As a result, the API returns only the data the area can hold.
The length of the receiver variable. If the length is larger than the size of the receiver variable, the results are not predictable. The minimum length is 8 bytes.
The content and format of the information returned. The possible format names are:
| RTVL0100 | Basic language identifier format |
See RTVL0100 Format for a description of this format.
The structure in which to return error information. For the format of the structure, see Error code parameter.
Following is the format of the information returned. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Bytes available |
| 4 | 4 | Binary(4) | Bytes returned |
| 8 | 8 | Binary(4) | Number of language identifiers retrieved |
| 12 | B | Binary(4) | CCSID value of descriptive text |
| 16 | 10 | Binary(4) | Offset to start of language identifier array |
| 20 | 14 | Char(*) | Reserved |
| Note: Format of language identifier array. The following fields are repeated for each language identifier entry. | |||
| 0 | 0 | Char(3) | Language Identifier |
| 3 | 3 | Char(40) | Descriptive text |
Bytes available. The number of bytes of information available.
Bytes returned. The number of bytes of information returned.
CCSID value of descriptive text. The coded character set identifier (CCSID) that all the descriptive texts are encoded in.
Descriptive text. The 40-character descriptive text associated with the language identifier.
Language identifier. The 3-character language identifier.
Number of language identifiers retrieved. The number of language identifiers in the list.
Offset to start of language identifier array. The offset to the start of the language identifier array.
Reserved. An ignored field.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | National Language Support APIs | APIs by category ]