| 1 | Request variable | Input | Char(*) |
| 2 | Length of request variable | Input | Binary(4) |
| 3 | Format name of request variable | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
The Send Response (QzdmSendResponse) API is used to send an acknowledgement and the response data over an OptiConnect path. A maximum of 32KB of data may be transferred in a single send response.
The following restrictions apply:
The request variable structure that describes the input for the Send Response (QzdmSendResponse) API.
The length of the request variable, in bytes. The length of the request variable must be at least equal to the length of the input format, and less than or equal to the maximum length of 4KB.
The format of the information that is provided as input for the Send Response (QzdmSendResponse) API. The SRSP0100 format is used by this API for the request variable. See SRSP0100 Format for more information on the SRSP0100 format.
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table defines the information required for Format SRSP0100.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(16) | Stream identifier |
| 16 | 10 | CHAR(8) | Transaction identifier |
| 24 | 18 | BINARY(4) | Actual response data length |
| 28 | 1C | CHAR(4) | Acknowledgement data |
| 32 | 20 | BINARY(4) | Offset to input descriptors |
| 36 | 24 | BINARY(4) | Number of input descriptors |
| 40 | 28 | CHAR(8) | Reserved |
| These fields repeat for each input descriptor | PTR(SPP) | Data buffer pointer | |
| BINARY(4) | Data buffer length | ||
| CHAR(12) | Reserved | ||
Acknowledgement data. The acknowledgement data for the request. This field is provided as output on the Receive Response (QzdmReceiveResponse) API and indicates the acknowledgement data.
Actual response data length. The actual length that is sent for the response data. If the response data that is sent is larger than the buffer that is provided on the Send Request (QzdmSendRequest) API, not all of the data is sent. It is the responsibility of the user's application program to retry the entire transaction by using a larger data buffer size for the Send Request (QzdmSendRequest) API to receive all of the data with the Receive Response (QzdmReceiveResponse) API.
Data buffer length. The length of the data buffer that is used for sending data.
Data buffer pointer. The pointer to the data buffer that is used for sending data.
Number of input descriptors. The number of input descriptors that are used. An input descriptor describes where the input data may be found. The input descriptor consists of a space pointer to a data buffer and the length of the data buffer. A maximum of three input descriptors may be specified.
Offset to input descriptors. The offset to the input descriptors.
Reserved. A reserved space for the purpose of aligning pointer values on a 16-byte boundary. This field must be initialized to binary 0.
Stream identifier. The OptiConnect stream that is used for communications. This field is provided as output on the Open Stream (QzdmOpenStream) API.
Transaction identifier. The specific transaction associated with this Send Response (QzdmSendResponse) API. This field is provided as output on the Receive Request (QzdmReceiveRequest) API.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFADF0 E | The OptiConnect QSOC subsystem must be active. |
| CPFADF1 E | OptiConnect communication error. |
| CPFADF3 E | OptiConnect path not valid or closed. |
| CPFADF4 E | OptiConnect detected sequence error. |
| CPFADF5 E | OptiConnect API internal error, function code &1, return code &2. |
| CPFADF6 E | Request variable not valid, reason code &1. |
| CPFADFF E | Transaction was terminated. |