Retrieve Window Data (QsnRtvWinDta) API

Required Parameter:

Window handle

Input

Binary(4)

Omissible Parameter Group:

User data pointer

Output

PTR(SPP)

Error code

I/O

Char(*)

Returned Value:

User data pointer

Output

PTR(SPP)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Window Data (QsnRtvWinDta) API returns a pointer to the user data for the given window.

Authorities and Locks

None.

Window handle: INPUT; BINARY(4)
A handle for the window for which the user data should be returned.

User data pointer: OUTPUT; PTR(SPP)
A space pointer to the user data field supplied in the user extension information when the window was defined. If no user data is associated with the window, the null pointer is returned.
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.

User data pointer: OUTPUT; PTR(SPP)
This API returns the value for the user data pointer parameter, or the null pointer if an error occurs.

Message ID

Error Message Text

CPF24B4 E

Severe error while addressing parameter list.

CPF3C1F E

Pointer is not on a 16 byte boundary.

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.

CPFA3AA E

Window handle incorrect.

API introduced: V2R3