| 1 | Input buffer handle | Input | Binary(4) |
| 2 | Query result | Output | Char(*) |
| 3 | Length of query result | Input | Binary(4) |
| 4 | Low-level environment handle | Input | Binary(4) |
| 5 | Error code | I/O | Char(*) |
| Return code | Output | Binary(4) |
The Retrieve Read Information (QsnRtvReadInf) API returns information about the input operation that filled the given input buffer.
None.
A handle for the input buffer that contains the results of the input operation.
The structure that contains the result of the query when the QsnRtvReadInf API has completed. The format of this structure is shown in Format of the Query Result.
The length of the query result parameter. The minimum value must be 8.
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.
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.
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(8) | Reserved |
| 16 | 10 | PTR(SPP) | Pointer to first byte of data |
| 32 | 20 | PTR(SPP) | Pointer to first byte of field data |
| 48 | 30 | BINARY(4) | Number of bytes of input data |
| 52 | 34 | BINARY(4) | Number of bytes of field data |
| 56 | 38 | BINARY(4) | Number of fields in input buffer |
| 60 | 3C | BINARY(4) | Number of bytes of data received |
| 64 | 40 | BINARY(4) | Row location of cursor |
| 68 | 44 | BINARY(4) | Column location of cursor |
| 72 | 48 | CHAR(1) | AID code for AID-associated read request |
| 73 | 49 | CHAR(7) | Reserved |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
AID code for AID-associated read request. AID code corresponding to key pressed to service an AID-associated read request. The input buffer must be filled as a result of a QsnReadInp, QsnReadMDT, or QsnReadMDTAlt operation. If the input buffer is filled as a result of any other input operation, this field is set to X'00'. See AID-Generating Keys for a description of the possible values.
Column location of cursor. Column location of cursor when the input operation was serviced. The input buffer must be filled as a result of a QsnReadInp, QsnReadMDT, QsnReadMDTAlt, QsnReadImm, or QsnReadMDTImmAlt operation. If the input buffer is filled as a result of any other input operation, this field is set to -1.
Number of bytes of data sent. Number of bytes of data sent from screen. If this value is larger than the number of bytes of input data, then truncation occurs on the input operation.
Number of bytes of field data. Number of bytes of field data in input buffer. This does not include the 3 bytes of header information (the cursor row and column, and the AID byte). The input buffer must be filled as a result of a QsnReadInp, QsnReadMDT, QsnReadMDTAlt, QsnReadImm, or QsnReadMDTImmAlt operation. If the input buffer is filled as a result of any other input operation, this field is set to -1.
Number of bytes of input data. Number of bytes of input data in input buffer. This includes header information such as row and column position.
Number of fields in input buffer. Number of fields in input buffer. This does not include header information such as row and column position. The input buffer must be filled as a result of a QsnReadMDT, QsnReadMDTAlt, or QsnReadMDTImmAlt operation. If the input buffer is filled as a result of any other input operation, or the input data format cannot be determined, this field is set to -1.
Pointer to first byte of data. Pointer to first byte of data in input buffer. This includes header information such as row and column position.
Pointer to first byte of field data. Pointer to first byte of field data in input buffer. This will be the first byte of data following the header information (the cursor row and column, and the AID byte). If the buffer does not contain field data, this field is set to the null pointer.
Reserved. An ignored field.
Row location of cursor. Row location of cursor when the input operation was serviced. The input buffer must be filled as a result of a QsnReadInp, QsnReadMDT, QsnReadMDTAlt, QsnReadImm, or QsnReadMDTImmAlt operation. If the input buffer is filled as a result of any other input operation, this field is set to -1.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1F E | Pointer is not on a 16 byte boundary. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| 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. |
| CPFA320 E | Pointer parameter is null. |
| CPFA32F E | Buffer type incorrect. |
| CPFA331 E | Buffer handle incorrect. |
| CPFA334 E | Low level environment handle incorrect. |
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]