Retrieve AID Code on Read (QsnRtvReadAID) API
Required Parameter:
1 | Input buffer handle | Input | Binary(4) |
Omissible Parameter Group:
2 | AID code | Output | Char(1) |
3 |
Error code | I/O | Char(*) |
Returned Value:
AID code | Output | Char(1) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve AID Code on Read (QsnRtvReadAID) API determines the AID code corresponding to the input operation that filled the given input buffer.
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. The input buffer must be filled as a result of a Read Input Fields (QsnReadInp), Read Modified Fields (QsnReadMDT), or Read Modified Alternate (QsnReadMDTAlt) operation. If the input buffer is filled as a result of any other input operation, a CPFA32E error is issued.
Omissible Parameter Group
- AID code
- OUTPUT; CHAR(1)
The variable that contains the AID code when the QsnRtvReadAID API has completed. See AID-Generating Keys for a description of the possible values.
- 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 or X'00' if an 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. |
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
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]