| 1 | Data | Input | Char(*) |
| 2 | Data length | Input | Binary(4) |
| 3 | Field ID | Input | Binary(4) |
| 4 | Row | Input | Binary(4) |
| 5 | Column | Input | Binary(4) |
| 6 | Starting monochrome attribute | Input | Char(1) |
| 7 | Ending monochrome attribute | Input | Char(1) |
| 8 | Starting color attribute | Input | Char(1) |
| 9 | Ending color attribute | Input | Char(1) |
| 10 | Command buffer handle | Input | Binary(4) |
| 11 | Low-level environment handle | Input | Binary(4) |
| 12 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Write Transparent Data (QsnWrtTDta) API writes n bytes of transparent data to the display.
This command allows transmission of data with any value (X'00' to X'FF') to the display screen. If the data destination is a 5250 display, and if the data X'04', X'11', or X'FF' is transmitted, unpredictable results occur. Note that if DBCS characters are included in the data, the host system does not perform IGC extension character processing. However, SI/SO characters will be processed correctly.
The display address after this operation is one position past the last data byte written to the screen.
This command corresponds indirectly to the 5250 Write to Display (WTD) command with a Set Buffer Address and a Transparent Data order. (For an indirect operation, a WTD is placed in the command buffer only if one does not already exist in that buffer.)
None
This command is not supported by all control units. A CPFA306 error occurs if an attempt is made to issue this command to a control unit that does not support it. Additional restrictions apply as for the Write Data (QsnWrtDta) API.
If the field ID given was created or last redefined by the QsnSetFldCC API, a CPFA346 will be signaled. This API should only be used to write data to fields that are not CCSID-capable. QsnWrtTDta is only able to enforce this for fields that have an associated field ID, however.
The data to be written to the screen.
The number of bytes of data to be written.
The field ID indicating the field at which to set the display address. If this parameter is specified with a nonzero value, the row and column parameters are ignored and the row and column values corresponding to the field ID are used to set the display address. If neither the field ID nor the row and column parameters are specified, the current display address is used.
The row at which to write the data. The row parameter must refer to a row no greater than the current screen or window mode height (if window mode is enabled). The actual screen row used for a screen I/O operation is calculated using the formula base+offset=actual. The base is the row location of the top window border (0 for full screen) if offset is positive, or the row location of the bottom window border (screen height plus 1 for full screen) if offset is negative. The offset is the row parameter value specified, and actual is the actual screen row to be used. A CPFA307 error occurs if an incorrect row value is specified.
If both the field ID and the row and column parameters are omitted, the data is written starting at the current display address. If this is the case and the command is a direct operation, or the buffer specified does not contain a preceding output operation that sets the display address, the current display address is set to row 1, column 1, prior to writing the data. Row and column must both be specified or omitted; one cannot be specified if the other is omitted.
The column at which to write the data. The column parameter must refer to a column no greater than the current screen or window mode width (if window mode is on). The actual screen column used for a screen I/O operation is calculated using the formula base+offset=actual. The base is the column location of the left window border (0 for full screen) if offset is positive, or the column location of the center window border (screen width plus 1 for full screen) if offset is negative. The offset is the column parameter value specified, and actual is the actual screen column to be used. A CPFA307 error occurs if an incorrect column value is specified.
The initial screen attribute for monochrome displays. If this parameter is omitted and monochrome attributes are to be used, no initial attribute is written to the display for the data. See Screen Attribute Characters for a description of the screen attribute values. The attribute parameters are specified with the same effect as for the QsnWrtDta operation.
The ending screen attribute for monochrome displays. If this parameter is omitted and monochrome attributes are to be used, no ending attribute is written to the display for the data.
The initial screen attribute for color displays. If this parameter is omitted and color attributes are to be used, no initial attribute is written to the display for the data.
The ending screen attribute for color displays. If this parameter is omitted and color attributes are to be used, no ending attribute is written to the display for the data.
A handle for the command buffer in which to store the command. If this parameter is specified, this is an indirect operation; the command is stored in the command buffer without an I/O operation taking place. If this parameter is omitted or specified with a zero value, this is a direct operation; the data is written to the screen at the specified location.
The low-level environment that the operation applies to. If this parameter is omitted or given with a value of zero, the default low-level environment is used.
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.
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
| 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. |
| CPFA301 E | Command buffer is full. |
| CPFA304 E | Data-stream error &1 reported for screen I/O operation. |
| CPFA305 E | Cannot add operation to command buffer. |
| CPFA306 E | Command not supported by current device. |
| CPFA307 E | Screen position &1, &2 outside of display or window area. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA31D E | Attempt to write outside of window area. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
| CPFA333 E | Parameter &1 not positive integer value. |
| CPFA334 E | Low level environment handle incorrect. |
| CPFA335 E | Screen address parameter error. |
| CPFA33C E | Undefined field ID &1. |
| CPFA343 E | Output operation not done. |
| CPFA344 E | The file &2 in library &3 is not valid. |
| CPFA345 E | The invite active flag is not valid. |
| CPFA346 E | Operation for field ID &1 not valid. |
| Top | Dynamic Screen Manager APIs | APIs by category |