Retrieve Pointer to Field Data (QsnRtvFldDta) API

The Retrieve Pointer to Field Data (QsnRtvFldDta) API returns a pointer to the first byte of field data in an input buffer after a Read Input Fields (QsnReadInp), Read Immediate (QsnReadImm), Read Modified Fields (QsnReadMDT), Read Modified Alternate (QsnReadMDTAlt), or Read Modified Immediate Alternate (QsnReadMDTImmAlt) operation. You can use the Retrieve Length of Field Data in Buffer (QsnRtvFldDtaLen) API to retrieve the length of this data. Refer to the Read Input Fields (QsnReadInp) API for a description of the format of the data returned.

To query the results from a QsnReadMDT, QsnReadMDTAlt, or QsnReadMDTImmAlt operation, you can also use the QsnRtvFldCnt and QsnRtvFldInf APIs. To query the result from any other input operations, use the QsnRtvDtaLen and 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

Pointer to field data

OUTPUT; PTR(SPP)

The variable that contains the pointer to the field data when the QsnRtvFldDta API has completed. The value returned by this API is the null pointer if the buffer contains no field data. Otherwise, it is equivalent to adding 3 bytes to the address returned by QsnRtvDta API. (The cursor and AID key values account for the first 3 bytes of input data returned.) This parameter must be on a 16-byte boundary.

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

Pointer to field data

OUTPUT; PTR(SPP)

This API returns the value for the pointer to field data parameter, or the null pointer otherwise.

Error Messages