Retrieve Pointer to Data in Input Buffer (QsnRtvDta) API

Required Parameter Group:

Input buffer handle

Input

Binary(4)

Omissible Parameter Group:

2	Pointer to input data	Output	PTR(SPP)
3	Error code	I/O	Char(*)

Returned Value:

Pointer to input data

Output

PTR(SPP)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Pointer to Data in Input Buffer (QsnRtvDta) API returns a pointer to the first byte of input data in an input buffer after a read operation.

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.

Omissible Parameter Group

Pointer to input data: OUTPUT; PTR(SPP)
The variable that contains the pointer to the input data after the QsnRtvDta API has completed. You can use the Retrieve Length of Data in Input Buffer (QsnRtvDtaLen) API to retrieve the length of this data. Refer to the appropriate read operation for a description of the format of the data returned. The value returned by this API is equivalent to the data returned by the system on an input operation. 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 input data: OUTPUT; PTR(SPP)
This API returns the value for the pointer to input data parameter, or the null pointer otherwise.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1F E	Pointer is not on a 16 byte boundary.
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.
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 ]