| 1 | Pad character | Input | Char(1) |
| 2 | To row | Input | Binary(4) |
| 3 | To column | Input | Binary(4) |
| 4 | From row | Input | Binary(4) |
| 5 | From column | Input | Binary(4) |
| 6 | Command buffer handle | Input | Binary(4) |
| 7 | Low-level environment handle | Input | Binary(4) |
| 8 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Pad between Two Screen Addresses (QsnWrtPadAdr) API pads the display repeatedly with a selected character between two positions on the screen. The current display address is set to the position given by the to-row and to-column values plus one. Padding may occur outside the logical window area defined by the low-level environment window mode setting.
This command corresponds indirectly to the 5250 Write to Display (WTD) command with a Set Buffer Address order (if the from row and from column parameters are specified) and a Repeat to Address order. (For an indirect operation, a WTD is placed in the command buffer only if one does not already exist in that buffer.)
None
The same restrictions apply as for the Write Data (QsnWrtDta) API.
The character to pad the screen with.
The row at which to write the last pad character. If the position to pad to is less than the position to pad from, a CPFA31B error is issued. 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.
The column at which to write the last pad character. 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 row at which to write the first pad character. 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 from-row and from-column parameters are omitted, the pad characters are written starting at the current display address. If 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 pad characters. Both the from-row and from-column parameters must be specified, or both parameters must be omitted.
The column at which to write the first pad character. 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.
A handle for the command buffer in which to store the command. If this parameter is omitted or specified as 0, this is a direct operation and the screen is padded with the character specified between the positions specified inclusively. Otherwise, this is an indirect operation and the command is stored in the command buffer without an I/O operation taking place.
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. |
| CPFA307 E | Screen position &1, &2 outside of display or window area. |
| CPFA308 E | Attempt to write data past end of display. |
| CPFA31B E | From position &1, &2 greater than to position &3, &4. |
| CPFA31D E | Attempt to write outside of window area. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
| 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. |
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]