End a Window (QsnEndWin) API

Required Parameter:

Window handle

Input

Binary(4)

Omissible Parameter Group:

2	Restore screen	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 End a Window (QsnEndWin) API ends a currently active window that was started with the Start a Window (QsnStrWin) API. The window is removed from the display on the screen and from the active window list. The data associated with the window is not deallocated.

Authorities and Locks

None.

Required Parameter

Window handle: INPUT; BINARY(4)
A handle for the window to be ended.

Omissible Parameter Group

Restore screen

INPUT; CHAR(1)

Indicates if the underlying display image should be restored when the window is ended. This parameter is ignored if the underlying display image was not saved. This option should be used if the screen will be refreshed by another application and does not need to be refreshed when the window is removed. Performance can be improved by not restoring the display image. However, the saved screen may not be restored properly if it is not restored by another application.

The possible values are:

0	Do not restore the screen when the window is ended.
1	Restore the screen, if saved, when the window is ended. This is the default.

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.
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.
CPFA3AB E	The value for &1 must be '0' or '1'.

API introduced: V2R3

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]