Retrieve Current Window (QsnRtvCurWin) API
Omissible Parameter Group:
| 1 | Current window handle | Output | Binary(4) |
| 2 | Error code | I/O | Char(*) |
Returned Value:
| Current window handle | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve Current Window (QsnRtvCurWin) API returns the handle for the current window.
Authorities and Locks
None.
Omissible Parameter Group
- Current window handle
- OUTPUT; BINARY(4)
The variable that contains the handle for the current window when the QsnRtvCurWin API has completed. If there is no current window, this parameter is set to 0.
- 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
- Current window handle
- OUTPUT; BINARY(4)
This API returns the value for the current window handle parameter. If there is no current window, this API returns 0.
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. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]