Retrieve Low-Level Environment Description (QsnRtvEnvD) API
Required Parameter Group:
| 1 | Low-level environment description | Output | Char(*) |
| 2 | Length of low-level environment description | Input | Binary(4) |
Omissible Parameter Group:
| 3 | Low-level environment handle | Input | Binary(4) |
| 4 | Error code | I/O | Char(*) |
Returned Value:
| Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve Low-Level Environment Description (QsnRtvEnvD) API returns the description corresponding to the specified low-level environment.
Authorities and Locks
None.
Required Parameter Group
- Low-level environment description
- Output; CHAR(*)
The variable that contains the low-level environment description when the QsnRtvEnvD API has completed. The format of the data returned is shown in Format of the Data Returned.
- Length of low-level environment description
- INPUT; Binary(4)
The length of the low-level environment description parameter. The minimum length is 8. If the length is larger than the size of the receiver variable, the results are not predictable. The API returns as much information as it can fit in this length. It 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.
Omissible Parameter Group
- Low-level environment handle
- INPUT; BINARY(4)
The low-level environment for which the description should be retrieved. If this parameter is omitted or specified as 0, the description for the default low-level environment is retrieved.
- 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.
Format of the Data Returned
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(*) | Environment description
The format of the remaining data returned is shown in Format of the Low-Level Environment Description. |
Error Messages
| 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. |
| CPFA334 E | Low level environment handle incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]