Retrieve Data (QPARTVDA) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Actual length of user data Output Binary(4)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve Data (QPARTVDA) API retrieves up to 1KB of user data, which was passed to this system with the Start Pass-through (QPASTRPT) API.


Authorities and Locks

None.


Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

User data associated with a pass-through session. You can specify the size of the area to be smaller than the data sent by the source system as long as you specify the length parameter correctly. As a result, the API returns only the data the area can hold.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable. If the length is larger than the size of the receiver variable, the results are not predictable.

Actual length of user data
OUTPUT; BINARY(4)

The actual length of user data associated with this pass-through session. If this value is greater than the length of receiver variable parameter, then truncation occurred.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3CF1 E Error code parameter not valid.
CPF3C19 E Error occurred with receiver variable specified.
CPF3C24 E Length of the receiver variable is not valid.
CPF3C90 E Literal value cannot be changed.
CPF8942 E Command or API call not allowed on source system.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R6
Top | Miscellaneous APIs | APIs by category