Retrieve Cursor Address on Read (QsnRtvReadAdr) API

Required Parameter Group:

Input buffer handle

Input

Binary(4)

Omissible Parameter Group:

2	Cursor row	Output	Binary(4)
3	Cursor column	Output	Binary(4)
4	Low-level environment handle	Input	Binary(4)
5	Error code	I/O	Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Cursor Address on Read (QsnRtvReadAdr) API determines the row and column position of the cursor when the input operation that filled the given input buffer has completed. You must specify at least one of the cursor row or the cursor column parameter. If both of these parameters are omitted, a CPFA31E error occurs.

The input buffer must be filled as a result of a Read Input Fields (QsnReadInp), Read Modified Fields (QsnReadMDT), Read Modified Alternate (QsnReadMDTAlt), Read Immediate (QsnReadImm), or Read Modified Immediate Alternate (QsnReadMDTImmAlt) operation. If the input buffer is filled as a result of any other input operation, a CPFA32E message is issued.

Authorities and Locks

None

Required Parameter

Input buffer handle: INPUT; BINARY(4)
A handle for the input buffer that contains the results of the input operation.

Omissible Parameter Group

Cursor row: OUTPUT; BINARY(4)
The variable that contains the row position of the cursor when the QsnRtvReadAdr API has completed.
Cursor column: OUTPUT; BINARY(4)
The variable that contains the column position of the cursor when the QsnRtvReadAdr API has completed.
Low-level environment handle: INPUT; BINARY(4)
The low-level environment that the operation applies to. If this parameter is omitted or given with a value of zero, the default low-level environment is used.
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.
CPFA319 E	No data in input buffer.
CPFA31E E	Required parameter &1 omitted.
CPFA32E E	Input data for query operation incorrect.
CPFA32F E	Buffer type incorrect.
CPFA331 E	Buffer handle incorrect.
CPFA334 E	Low level environment handle incorrect.

API introduced: V2R3

Top | Dynamic Screen Manager APIs | APIs by category