Retrieve Window Description (QsnRtvWinD) API

Required Parameter Group:

1	Window handle	Input	Binary(4)
2	Window description	Output	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 Retrieve Window Description (QsnRtvWinD) API retrieves a copy of the window description for the given window.

Authorities and Locks

None.

Window handle: INPUT; BINARY(4)
A handle for the window for which the window description should be returned.
Window description: OUTPUT; CHAR(*)
The window description for the given window. The format of the data returned is shown in Format of the Window Description Returned.
Length of window description: INPUT; BINARY(4)
The length of the window description parameter. If the length is larger than the size of the receiver variable, the results are not predictable. The minimum length is 8. The API returns as much information as it can fit in this length. If the available information is longer, it is truncated. If the available information is shorter, the unused output is unchanged; whatever is already stored in that space remains there. To determine how much information the API actually returns in response to this call, see the bytes returned field. To determine how much information the API could return if space were available, see the bytes available field.

Error code: I/O; CHAR(*)
Thestructure 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.

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.

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Window description. The format of the remaining data returned is shown in Format of the Window Description.

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C24 E	Length of the receiver variable is not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA31E E	Required parameter &1 omitted.
CPFA3AA E	Window handle incorrect.

API introduced: V2R3