Retrieve Low-Level Environment User Data (QsnRtvEnvDta) API

Required Parameter:

Low-level environment 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 Low-Level Environment User Data (QsnRtvEnvDta) API returns a pointer to the user data for the given low-level environment.

Authorities and Locks

None.

Low-level environment handle: INPUT; BINARY(4)
A handle for the low-level environment for which the user data should be returned. If this parameter is omitted or specified as 0, the default low-level environment is used.

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

CPFA31E E

Required parameter &1 omitted.

CPFA334 E

Low level environment handle incorrect.

API introduced: V2R3