Retrieve Length of Field Data in Buffer (QsnRtvFldDtaLen) API
Required Parameter Group:
| 1 | Input buffer handle | Input | Binary(4) |
Omissible Parameter Group:
| 2 | Length of field data | Output | Binary(4) |
| 3 | Error code | I/O | Char(*) |
Returned Value:
| Length of field data | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Retrieve Length of Field Data in Buffer (QsnRtvFldDtaLen) API determines the number of bytes of field data returned after a Read Input Fields (QsnReadInp) or Read Immediate (QsnReadImm) input operation. You can use the Retrieve Pointer to Field Data (QsnRtvFldDta) API to retrieve a pointer to this data so that you can parse the field values. Refer to the Read Input Fields (QsnReadInp) API for a description of the format of the data returned.
To query the results from a Read Modified Fields (QsnReadMDT), Read Modified Alternate (QsnReadMDTAlt), or Read Modified Immediate Alternate (QsnReadMDTImmAlt) operation, use the Retrieve Number of Fields Read (QsnRtvFldCnt) and Retrieve Field Information (QsnRtvFldInf) APIs. To query the result from any other input operation, use the Retrieve Length of Data in Input Buffer (QsnRtvDtaLen) and Retrieve Pointer to Data in Input Buffer (QsnRtvDta) APIs.
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 QsnReadInp or QsnReadImm operation.
Omissible Parameter Group
- Length of field data
- OUTPUT; BINARY(4)
The variable that contains the field data length when the QsnRtvFldDtaLen API has completed. The field data length is 3 bytes less than the value returned by the QsnRtvDtaLen API. (The cursor and AID-key values account for the first 3 bytes of the input data returned).
- 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
- Length of field data
- OUTPUT; BINARY(4)
This API returns the value for the length of field data parameter, 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
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]