Retrieve Session Description (QsnRtvSsnD) API
Required Parameter Group:
1 | Session handle | Input | Binary(4) |
2 | Session description | Output | Char(*) |
3 | Length of session description | Input | Binary(4) |
Omissible Parameter:
4 | Error code | I/O | Char(*) |
Returned Value:
Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve Session Description (QsnRtvSsnD) API retrieves a copy of the session description for the given session. The session description may be different from the session description used when the Create a Session (QsnCrtSsn) or the Change Session (QsnChgSsn) API is called. The following fields will have actual values replacing 0 (if used):
Number of rows in scroller
Number of columns in scroller
Default number of rows to roll scroller by
Default number of columns to shift scroller by
Authorities and Locks
None.
Required Parameter Group
- Session handle
- INPUT; BINARY(4)
A handle for the session for which the session description should be returned.
- Session description
- OUTPUT; CHAR(*)
The format of the data is shown in Format of the Session Description Returned.
- Length of session description
- INPUT; BINARY(4)
The length of the session description parameter.
Omissible Parameter
- 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 Session Description Returned
Offset | Type | Field | |
---|---|---|---|
Dec | Hex | ||
0 | 0 | BINARY(4) | Bytes returned |
4 | 4 | BINARY(4) | Bytes available |
8 | 8 | CHAR(8) | Reserved |
16 | 10 | CHAR(*) | Session description. The format of the remaining data returned is shown in Format of the Session 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. |
CPFA3D6 E | Session handle is incorrect. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]