Retrieve Session Data (QsnRtvSsnDta) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter Group:

2	User data pointer	Output	PTR(SPP)
3	Error code	I/O	Char(*)

Returned Value:

User data pointer

Output

PTR(SPP)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Session Data (QsnRtvSsnDta) API returns a pointer to the user data for the given session. The user data is the pointer specified on the session description and consists of user-specified data that is associated with the session. See Format of the Session Description for details.

Authorities and Locks

None

Required Parameter

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

Omissible Parameter Group

User data pointer: OUTPUT; PTR(SPP)
A pointer to the user data, as specified on the session description, for the given session.
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

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

Error Messages

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.
CPFA31E E	Required parameter &1 omitted.
CPFA340 E	Operation not supported with double-byte data.
CPFA3A4 E	Specified window is not active.
CPFA3D6 E	Session handle is incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category