Query If Scroller in Line Wrap Mode (QsnQrySclWrp) API
Required Parameter:
| 1 | Session handle | Input | Binary(4) |
Omissible Parameter Group:
| 2 | Wrap indication | Output | Char(1) |
| 3 | Error code | I/O | Char(*) |
Returned Value:
| Wrap indication | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Query If Scroller in Line Wrap Mode (QsnQrySclWrp) API queries if line wrap mode is set on or off for the given session.
Authorities and Locks
None.
Required Parameter
- Session handle
- INPUT; BINARY(4)
A handle for the session to be queried.
Omissible Parameter Group
- Wrap indication
- OUTPUT; CHAR(1)
Whether line wrap mode is on or off. The possible values are:
0 Line wrap mode is off. 1 Line wrap mode is on.
- 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
- Wrap indication
- OUTPUT; BINARY(4)
This API returns the value for the wrap indication parameter 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. |
| CPFA3D6 E | Session handle is incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]