Get Cursor Address with AID (QsnGetCsrAdrAID) API

Omissible Parameter Group:

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

Returned Value:

Return code

Output

Binary(4)

  Public Default Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Get Cursor Address with AID (QsnGetCsrAdrAID API returns the cursor address after an AID-generating key is pressed. Either the cursor row or the cursor column parameter must be specified. If both of these parameters are omitted, a CPFA31E error occurs.

This command corresponds indirectly to the 5250 Read Input Fields command. Because the control characters specified on the underlying command are both X'00', this operation may cause the cursor to move to the default, or insert cursor, position when the keyboard is unlocked.

Authorities and Locks

None

Omissible Parameter Group

Cursor row

OUTPUT; BINARY(4)

The variable that contains the cursor row when the QsnGetCsrAdrAID API has completed.

Cursor column

OUTPUT; BINARY(4)

The variable that contains the cursor column when the QsnGetCsrAdrAID API has completed.

AID code

OUTPUT; CHAR(1)

The variable that contains the AID code when the QsnGetCsrAdrAID 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.
CPFA301 E	Command buffer is full.
CPFA304 E	Data-stream error &1 reported for screen I/O operation.
CPFA305 E	Cannot add operation to command buffer.
CPFA31E E	Required parameter &1 omitted.
CPFA326 E	Screen must be redrawn.
CPFA331 E	Buffer handle incorrect.
CPFA334 E	Low level environment handle incorrect.
CPFA343 E	Output operation not done.
CPFA344 E	The file &2 in library &3 is not valid.
CPFA345 E	The invite active flag is not valid.

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.

CPFA301 E

Command buffer is full.

CPFA304 E

Data-stream error &1 reported for screen I/O operation.

CPFA305 E

Cannot add operation to command buffer.

CPFA31E E

Required parameter &1 omitted.

CPFA326 E

Screen must be redrawn.

CPFA331 E

Buffer handle incorrect.

CPFA334 E

Low level environment handle incorrect.

CPFA343 E

Output operation not done.

CPFA344 E

The file &2 in library &3 is not valid.

CPFA345 E

The invite active flag is not valid.