Clear Scroller (QsnClrScl) API
Required Parameter:
| 1 | Session handle | Input | Binary(4) |
Omissible Parameter Group:
| 2 | Resize indication | Input | Char(1) |
| 3 | Error code | I/O | Char(*) |
Returned Value:
| Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Clear Scroller (QsnClrScl) API clears the scroller data associated with a session and optionally resizes the scroller buffer.
Authorities and Locks
None.
Required Parameter
- Session handle
- INPUT; BINARY(4)
A handle for the session to be cleared. All data in the scroller will be cleared.
Omissible Parameter Group
- Resize indication
- Input; CHAR(1)
Whether the scroller buffer should be resized when it is cleared.
0 Maintain current buffer size and data. This is the default. 1 Resize the buffer to the initial size given on the session description.
- 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. |
| CPFA314 E | Memory allocation error. |
| CPFA31E E | Required parameter &1 omitted. |
| 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. |
| CPFA3AB E | The value for &1 must be '0' or '1'. |
| CPFA3D6 E | Session handle is incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]