Get AID (QsnGetAID) API

Omissible Parameter Group:

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

Returned Value

AID code

Output

Char(1)

  Service Default Program: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Get AID (QsnGetAID) API waits for an AID-generating key to be pressed.

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 will cause the cursor to move to the insert cursor position when the keyboard is unlocked.

Authorities and Locks

None.

Omissible Parameter Group

AID code: OUTPUT; CHAR(1)
The variable that contains the AID code when the QsnRtvReadAID 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

AID code: OUTPUT; CHAR(1)
This API returns the value for the AID code parameter, X'00' if a general error occurs during processing.

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.
CPFA303 E	Error occurred for screen I/O operation.
CPFA304 E	Data-stream error &1 reported for screen I/O operation.
CPFA326 E	Screen must be redrawn.
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.

API introduced: V2R3

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