Delete Buffer (QsnDltBuf) API
Required Parameter Group:
| 1 | Buffer handle | Input | Binary(4) |
Omissible Parameter:
| 2 | Error code | I/O | Char(*) |
Returned Value:
| Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Delete Buffer (QsnDltBuf) API deletes a command or input buffer created with the Create Command Buffer (QsnCrtCmdBuf) or the Create Input Buffer (QsnCrtInpBuf) API, respectively. All storage associated with the buffer is deallocated.
Authorities and Locks
None.
Required Parameter
- Buffer handle
- Input; BINARY(4)
A handle for the buffer to be deleted.
Omissible Parameter
- 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. |
| CPFA31E E | Required parameter &1 omitted. |
| CPFA331 E | Buffer handle incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]