Retrieve CCSID Text (QLGRTVCT) API

The Retrieve CCSID Text (QLGRTVCT) API retrieves different subsets of CCSIDs' values and their descriptions, if available. A typical use of this API would be to retrieve all the CCSIDs that are valid for a job.

Authorities and Locks

None.

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The variable to receive the requested information. You can specify the size of the area to be smaller than the format requested, provided you specify the length of the receiver variable parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The content and format of the information returned. The possible format name is:

RTVT0100

Basic CCSID information format. For details about the format, see Format of the Generated Information.

CCSID Request Type

INPUT; Binary(4)

The type of CCSID requested.

0	Retrieve all supported CCSIDs valid for this job.
1	Retrieve all supported CCSIDs valid for any job.
2	Retrieve all supported CCSIDs for the provided encoding scheme.
3	Retrieve the current default job CCSID value.

CCSID request type encoding scheme selection

INPUT; Char(2)

The encoding scheme requested. If request type is not 2, this parameter must be x'0000'.

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 Information

Following is the format of the information returned. For detailed descriptions of the fields in the table, see Field Descriptions.

RTVT0100 Format

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
12	C	BINARY(4)	CCSID value for descriptive texts
16	10	BINARY(4)	Offset to start of CCSID identifier array
20	14	BINARY(4)	Number of CCSIDs returned
24	18	BINARY(4)	Size of each CCSID entry
28	1D	CHAR(*)	Reserved

Format of CCSID Array

The following fields are repeated for each CCSID entry.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	CCSID identifier
4	4	BINARY(4)	Length of descriptive text
2	2	CHAR(*)	Descriptive text

Field Descriptions

Bytes available. The number of bytes of information available.

Bytes returned. The number of bytes of information returned.

CCSID value for descriptive text. The coded character set identifier (CCSID) in which all the descriptive texts are encoded.

Offset to start of CCSID array. The offset to the start of the CCSID array.

Number of CCSIDs retrieved. The number of CCSIDs in the list.

Size of each CCSID entry. The size in bytes for each CCSID entry.

CCSID identifier The CCSID value.

Length of Descriptive Text. The length (in bytes) of the descriptive text.

Descriptive text. The zero to 95-byte long descriptive text associated with the CCSID.

Reserved. An ignored field.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Sever 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.

---

API introduced: V5R1

---

[ Back to top | National Language Support APIs | APIs by category ]