Retrieve Available Data (QsnRtvAvailData) API

The Retrieve Available Data (QsnRtvAvailData) API is used to retrieve invited available data. If the invite active flag is on in a low-level environment description when an output operation is done, the end user is able to enter data. If a subsequent output operation is done, without checking for input using the QsnReadInvited API, and the user has entered data, DSM will store the end user's data in an internal input buffer and issue CPFA343. The Retrieve Available Data (QsnRtvAvailData) API will copy the data into the specified input buffer, as well as return the read command that is used to fill the buffer.

Authorities and Locks

None

Required Parameter Group

Input buffer handle

INPUT; BINARY(4)

A handle for the input buffer where available data should be moved.

Read command used

OUTPUT; CHAR(1)

The read command that was used to fill the input buffer. This can be used to determine what buffer manipulation API to use to retrieve the data from the input buffer. The possible values are:

X'42'	Read input fields
X'52'	Read MDT fields
X'72'	Read immediate
X'82'	Read MDT alternate

Omissible Parameter Group

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

Return code

OUTPUT; BINARY(4)

A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.

Error Messages