Set Current Window (QsnSetCurWin) API
Required Parameter:
1 | Window 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 Set Current Window (QsnSetCurWin) API makes the given window the current window. The QsnSetCurWin API draws the window with the current window border attribute, if specified. The Current Window exit routine, if specified on the window description, is called after the given window becomes current. The current window overlays all other windows on the display screen.
Authorities and Locks
None
Required Parameter
- Window handle
- INPUT; BINARY(4)
A handle for the window that will become current.
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. |
CPFA318 E | Error calling exit routine. |
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. |
CPFA3A4 E | Specified window is not active. |
CPFA3AA E | Window handle incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]