Change Window (QsnChgWin) API

Required Parameter Group:

1	Window handle	Input	Binary(4)
2	Window description	Input	Char(*)
3	Length of window description	Input	Binary(4)

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Change Window (QsnChgWin) API changes the window description for the given window. The size cannot be changed for a window that contains DBCS data.

Authorities and Locks

Exit Routine Authority: *EXECUTE

Required Parameter Group

Window handle: INPUT; BINARY(4)
A handle for the window that will have its description changed.
Window description: INPUT; CHAR(*)
The new window description for the given window. The format of the window description is shown in Format of the Window Description.
Length of window description: Input; BINARY(4)
The length of the window description parameter.

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.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA314 E	Memory allocation error.
CPFA318 E	Error calling exit routine.
CPFA31E E	Required parameter &1 omitted.
CPFA340 E	Operation not supported with double-byte data.
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.
CPFA3A1 E	Window description value is incorrect.
CPFA3AA E	Window handle incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category