Retrieve Buffer Size (QsnRtvBufSiz) API
Required Parameter Group:
| 1 | Buffer handle | Input | Binary(4) |
Omissible Parameter Group:
| 2 | Buffer size | Output | Binary(4) |
| 3 | Error code | I/O | Char(*) |
Returned Value:
| Buffer size | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve Buffer Size (QsnRtvBufSiz) API returns the total number of bytes allocated for a command or input buffer. The result returned from this API is the current allocated buffer size, including any increments that may have taken place.
Authorities and Locks
None.
Required Parameter
- Buffer handle
- INPUT; BINARY(4)
A handle for the buffer to be queried.
Omissible Parameter Group
- Buffer size
- OUTPUT; BINARY(4)
The variable containing the buffer size after the QsnRtvBufSiz API has completed.
- 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
- Buffer size
- OUTPUT; BINARY(4)
This API returns the value for the buffer size parameter, 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 ]