Retrieve Session Line to Input Line (QsnRtvSsnLin) API

Required Parameter:

Session handle

Input

Binary(4)

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Session Line to Input Line (QsnRtvSsnLin) API retrieves the input line from the scroller that corresponds to the cursor position within the scroller. If the cursor is outside the scroller and the retrieve request directly follows another retrieve with no intervening I/O operations, then the line before the line previously retrieved is returned. Otherwise, the last input line is retrieved. If there is no input data, this API still completes successfully.

Restrictions

The data on the retrieved line may be incompatible with the current state of the session input line. This may happen when QsnReadSsnDta echoes input to the scroller, and that data is later retreived on a call or after a call of QsnReadSsnDtaCC. If the session input line does not support the data of the retrieved line, CPFA3E1 will be signaled and placed on the session message line. The scroller line will not be retrieved to the session input line, since the data can be corrupted or misinterpreted.

Authorities and Locks

None.

Required Parameter

Session handle: INPUT; BINARY(4)
A handle for the session for which to retrieve the input line.

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.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA31E E	Required parameter &1 omitted.
CPFA3A4 E	Specified window is not active.
CPFA3D6 E	Session handle is incorrect.
CPFA3E1 E	Data not compatible with session input line.

API Introduced: V2R3

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]