Put Command Buffer (QsnPutBuf) API
Required Parameter Group:
| 1 | Command buffer handle | Input | Binary(4) |
Omissible Parameter Group:
| 2 | Low-level environment handle | Input | Binary(4) |
| 3 | Error code | I/O | Char(*) |
Returned Value:
| Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Put Command Buffer (QsnPutBuf) API sends the commands accumulated in a command buffer to the screen. This corresponds to a write operation to the display file. If the command buffer contains no data, the operation returns successfully, but no I/O operation is performed.
Authorities and Locks
None.
Required Parameter
- Command buffer handle
- INPUT; BINARY(4)
A handle for the command buffer. The command buffer is not modified in any way as a result of this command.
Omissible Parameter Group
- Low-level environment handle
- INPUT; BINARY(4)
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.
- 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.
Returned Value
- Return code
- OUTPUT; BINARY(4)
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
Error Messages
| 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. |
| CPFA303 E | Error occurred for screen I/O operation. |
| CPFA304 E | Data-stream error &1 reported for screen I/O operation. |
| CPFA308 E | Attempt to write data past end of display. |
| CPFA309 E | Invalid cursor position in command buffer. |
| CPFA30A E | Field length &1 not valid. |
| CPFA30B E | Invalid starting address for field. |
| CPFA30C E | Maximum allowable number of fields exceeded. |
| CPFA316 E | Saved data not valid. |
| CPFA31B E | From position &1, &2 greater than to position &3, &4. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
| CPFA334 E | Low level environment handle incorrect. |
| CPFA338 E | Command buffer contains an input operation. |
| 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. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]