| 1 | CCSID1 | Input | Int(4) |
| 2 | SEL | Input | Int(4) |
| 3 | N1 | Input | Int(4) |
| 4 | N2 | I/O | Int(4) |
| 5 | CTLFDF | Output | Array of Int(4) |
| 6 | FB | Output | Feedback |
The Get Control Function Definition (CDRGCTL, QTQGCTL) API gets a requested control function definition associated with a given CCSID. The following control function definitions are defined in the CCSID resource repository model:
Additionally, the following other definitions are included in this repository:
Each control function definition is defined as a triplet consisting of:
Each control function may be defined for each of the possible code extension switching states associated with the CCSID. There is, at most, one code point definition for a control function within a switching state.
If the string type definition is selected it's value will be returned in the first value of the triplet. The remaining two values of the triplet will be returned as 0.
A selection parameter (SEL) is used to identify which control function definition is to be returned by the function.
None.
This variable contains the CCSID value referenced; a positive number in the range 1 to 65,279.
This variable contains the selection specification, a non-negative number in the range 0 to 255. If the selected control function element is available in the resource definition for CCSID1, the triplets are returned in the area starting at CTLFDF. The following values are currently defined for SEL:
| SEL | Selected Control Function |
|---|---|
| 0 | Space |
| 1 | Substitute |
| 2 | New Line |
| 3 | Line Feed |
| 4 | Carriage Return |
| 5 | End of File |
| 100 | String Type |
This variable contains the size of the allocated area starting at CTLFDF to contain the returned data. N1 is specified as a number of elements. Each triplet is counted as 3 elements. It is a positive number whose minimum value is 3.
This variable contains the number of values returned in CTLFDF. The first invocation of this function must have N2 initialized to zero. It is a non-negative integer and is a multiple of 3 (corresponding to each triplet in CTLFDF). If no definition is found in the CCSID resource for the requested element, a value of 0 is returned in N2.
The start of the area to contain the selected definition elements. Each element is a triplet of 3 binary(4) values. For each triplet, the first value is the code point, the second is the code point width, and the third value contains the switching state number. There is one triplet returned for each switching state for CCSID1. An undefined element is indicated by a zero state number in the corresponding CTLFDF entry.
If the string type definition is selected it's value will be returned in the first value of the triplet. The remaining two values of the triplet will be returned as 0. The following table provides a definition of each of the string types:
| String Type | Text Type | Numeric Shaping | Orientation | Text Shaping | Symmetrical Swapping |
|---|---|---|---|---|---|
| 4 | Visual | Passthrough | LTR | Shaped | Off |
| 5 | Implicit | Arabic | LTR | Unshaped | On |
| 6 | Implicit | Arabic | RTL | Unshaped | On |
| 7(*) | Visual | Passthrough | Contextual * | Unshaped-Ligatures | Off |
| 8 | Visual | Passthrough | RTL | Shaped | Off |
| 9 | Visual | Passthrough | RTL | Shaped | On |
| 10 | Implicit | Contextual LTR | On | ||
| 11 | Implicit | Contextual RTL | On |
(*) Field orientation is left to right (LTR), when first alphabetic character is a Latin one, and right to left (RTL) when it is a Bidi (RTL) character; characters are unshaped, but LamAlef ligatures are kept, and not broken into constituents.
The function returns in this feedback array the processing status (and any associated reason) for this function. The field type is an array of three 32-bit two's complement binary values (12 bytes, or 96 bits); the status code is a non-negative number in the first 16 bits, and the reason code is a non-negative number in the second 16 bits. The following are specific meanings of the status code and associated reason code values (in hexadecimal) contained in the first 32 bits of FB.
| Status | Reason | Meaning |
|---|---|---|
| 0000 | 0000 | The function completed successfully. |
| 0001 | 0001 | CCSID1 value is not in the CCSID resource repository. |
| 0001 | 0004 | One or more of the requested control function definitions are undefined (as indicated by a zero value for its corresponding state number in CTLFDF). |
| 0001 | 000A | The requested control function definition element in the CCSID resource for CCSID1 was not found. |
| 0002 | 0001 | CCSID1 value is 0, which is reserved for indicating a default in a hierarchy. The caller must resolve the default before calling this function. |
| 0003 | 0001 | CCSID1 has one of the special-purpose CCSID values in the range 65,280 to 65,535. |
| 0004 | 0001 | The allocated length (value of N1) for the area to contain returned values was insufficient to contain all the output data that is to be returned. |
| 0005 | 0002 | N2 is greater than N1. However, the start of the next block of data to be returned is outside the valid range 1 to N2max. |
| 0005 | 0003 | The value specified in the SEL parameter is not supported. |
| 0005 | 000A | N2 is less than or equal to N1, but is not 0. |
| 0006 | 0001 | The CCSID resource repository was not found. |
| 0006 | 0002 | The CCSID resource repository is currently unavailable. |
| 0007 | 0001 | The system CCSID resource repository accessed by the function was found to be not valid in the structure. |
| 0008 | 0001 | CCSID1 value is not in the range 0 to 65,535. |
| 0008 | 0002 | N1 is greater than the maximum permitted in this implementation. (The maximum permitted is 99.) |
| 0008 | 000A | N1 is less than 3. |
| 0008 | 000B | SEL value is not in the range 0 to 255. |
Exceptions issued: CPF9872 - Program &1 in library &2 ended.
For example, for CCSID 00037, the return value, if the space was asked for, would be X'00000040'. This is interpreted as a 1 byte value of X'40'.
[ Back to top | National Language Support APIs | APIs by category ]