Retrieve Length of Data in Input Buffer (QsnRtvDtaLen) API

Required Parameter Group:

Input buffer handle

Input

Binary(4)

Omissible Parameter Group:

2	Input data length	Output	Binary(4)
3	Error code	I/O	Char(*)

Returned Value:

Input data length

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Retrieve Length of Data in Input Buffer (QsnRtvDtaLen) API determines the number of bytes of input data contained in an input buffer after an input 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

Input data length: OUTPUT; BINARY(4)
The variable that contains the input data length when the QsnRtvDtaLen API has completed. This number may be smaller than the number of bytes actually read if the input buffer was not large enough to hold all the data. Use the Retrieve Number of Bytes Read from Screen (QsnRtvReadLen) API to determine the amount of data actually read from the screen. If the value returned by the QsnRtvReadLen API is less than the input data length, then truncation of the input data occurred.

Returned Value

Input data length: OUTPUT; BINARY(4)
This API returns the value for the input data length 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.
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 ]