Receive Data (QNMRCVDT) API
Required Parameter Group:
| 1 | Handle | Input | Binary(4) |
| 2 | Receiver variable | Output | CHAR(*) |
| 3 | Length of receiver variable | Input | Binary(4) |
| 4 | Request identifier | Input | CHAR(53) |
| 5 | Remote application name | Output | CHAR(24) |
| 6 | Data type | Output | CHAR(10) |
| 7 | Wait time | Input | Binary(4) |
| 8 | Error code | I/O | CHAR(*) |
Default Public Authority: *USE
Threadsafe: No
The Receive Data (QNMRCVDT) API, an SNA/Management Services Transport API, receives a particular request, reply, or error message.
The receiver variable data area is not changed unless it is large enough to hold all of the data received. If the receiver variable is not large enough to hold the received data, then an error message is returned indicating how much more space is needed. The application can allocate a new buffer size greater than or equal to the bytes available and call the Receive Data (QNMRCVDT) API again. If the received data is smaller than the receiver variable, any data in the unused portion of the variable is unchanged.
Authorities and Locks
None.
Required Parameter Group
- Handle
- INPUT; BINARY(4)
The unique identifier for this application, which was returned by the Start Application (QNMSTRAP) API.
- Receiver variable
- OUTPUT; CHAR(*)
The variable in which this API returns the data. This structure includes the bytes returned and bytes available in addition to the received data.
The format of the receiver variable is:
Offset Type Field 0 BINARY(4) Bytes returned 4 BINARY(4) Bytes available 8 CHAR(*) Received data The bytes returned field specifies the length of the bytes actually returned. The bytes available field specifies the total length of data available to be returned.
- Length of receiver variable
- INPUT; BINARY(4)
The size of the receiver variable parameter, which is the maximum amount of data that can be returned in the receiver variable.
- Request identifier
- INPUT; CHAR(53)
The request identifier of the data being received.
*PRV The last request identifier used (for example, the one returned on the Send Request (QNMSNDRQ) API).
- Remote application name
- OUTPUT; CHAR(24)
The name of the remote application that sent the data. The first 8 characters contain the network ID, the second 8 characters contain the control point name (or the logical unit name may be used), and the third 8 characters contain the application name of the remote application.
- Data type
- OUTPUT; CHAR(10)
The type of data returned.
*RQS A request was received. No reply is expected. *RQSRPY A request was received. A reply is expected. *RPYCPL A complete reply was received. This is either the last or only reply. *RPYINCPL An incomplete reply was received. Additional Receive Data (QNMRCVDT) operations should be performed. *NODATA No data was received. Either an error occurred or the wait time elapsed.
- Wait time
- INPUT; BINARY(4)
The amount of time the application waits for the data to be received.
-1 Waits for data to be received (no matter how long it takes) or for a condition such that the reply cannot be received (for example, a communications failure). 0-99999 The number of seconds the application waits.
- 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. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF7AC0 E | &3.&4 cannot receive data at this time. |
| CPF7AC4 E | Control point &3.&4 rejected data. |
| CPF7ADC E | Internal processing error. |
| CPF7ADD E | Operation did not complete. |
| CPF7ADF E | Session failure. Cannot send data at this time. |
| CPF7AEA E | Application on control point &3.&4 failed. |
| CPF7AEC E | Wait time &3 not between -1 and 99999. |
| CPF7AE0 E | Function requested not supported by remote system. |
| CPF7AE2 E | Handle &1 not found. |
| CPF7AE3 E | Management Services transport operation not permitted. |
| CPF7AE6 E | Communication with control point &3.&4 failed. |
| CPF7AE7 E | Remote application program &5 not found. |
| CPF7AE8 E | Receiver variable too small. |
| CPF7AE9 E | Request identifier not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R2
[ Back to top | Network Management APIs | APIs by category ]