| 1 | Message key | Input | Char(4) |
| 2 | Qualified message queue name | Input | Char(20) |
| 3 | Reply text | Input | Char(*) |
| 4 | Length of reply text | Input | Binary(4) |
| 5 | Remove message | Input | Char(10) |
| 6 | Error code | I/O | Char(*) |
| 7 | Coded character set identifier | Input | Binary(4) |
| 8 | Allow default reply rejection | Input | Char(10) |
The Send Reply Message (QMHSNDRM) API sends a reply message to the sender of an inquiry message.
If your application attempts to diagnose and recover from errors, it might need to take additional action when using the QMHSNDRM API. When the QMHSNDRM API encounters errors in the reply being sent, it sends a diagnostic message describing each error to your program message queue. After the last diagnostic message, the QMHSNDRM API sends a general escape message, CPF2422. Exit point QIBM_QMH_REPLY_INQ has been added to the system registration facility to allow an exit program to be called when a reply is sent to an inquiry message. A reply handling exit program can accept, reject or replace the reply value. If the reply is rejected, a diagnostic is sent followed by CPF2422 as indicated above. If the reply value sent with this API is replaced by a reply handling exit program, CPF2458 (Reply replaced by reply handling exit program) is sent as a diagnostic message to the caller of the QMHSNDRM API to identify the new reply value and then the CPF2458 is sent again as a status message that could be monitored to allow an application to be notified of the reply replacement.
To diagnose and recover from these errors, your application should call the QMHRCVPM API to receive the diagnostic messages sent.
The key to the inquiry message that the reply answers. The key is assigned by the command or API that sends the message. You can obtain the key in these ways:
The name of the message queue containing the inquiry message being answered, and the library in which it resides. The message queue is the one in which the inquiry--not the sender's copy--is located. The first 10 characters specify the message queue, and the second 10 characters specify the library.
You can use special value *EXT to send a reply to an inquiry message on the job's external message queue. The library portion of the name must be set to blanks. This value can be used by an inquiry handling exit program to send a reply to an inquiry on *EXT that needs a reply.
When a message queue name other than *EXT is specified, you can use these special values for the library name:
| *CURLIB | The job's current library |
| *LIBL | The library list |
The complete text of the reply being sent. To send the default reply stored in the message description, use blanks for this parameter. A reply handling exit program can be used to limit the use of default replies. See the allow default reply rejection parameter below for more information.
The length of the reply text, in bytes. If you use blanks in the reply text parameter to indicate that you are using the default reply, you can specify any valid value for this parameter. Valid values are 1 through 132.
Whether the inquiry message and the reply are removed from the message queue after the reply is sent. Valid values follow:
| *NO | Keep the inquiry message and the reply. |
| *YES | Remove the inquiry message and the reply. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The coded character set identifier (CCSID) that the supplied message reply text is in. The following values are allowed:
| 0 | The message reply text is assumed to be in the CCSID of the job running this API. This is the default value if this parameter is not specified. |
| 65535 | The message reply text will not be converted. |
| CCSID | Specify a valid CCSID that your message reply text is in. Valid values are between 1 and 65535. This API will validate the CCSID. |
For a list of valid CCSIDs, see CCSID support for messages.
Specifies whether a reply handling exit program will be allowed to reject a default reply. A default reply is requested by using blanks as the value for the reply text parameter. A reply handling exit program can be registered using the system registration facility for exit point QIBM_QMH_REPLY_INQ. If this parameter is not specified, a value of *NO is used. Valid values are:
| *NO | A reply handling exit program will not be allowed to reject a default reply. |
| *YES | A reply handling exit program will
be allowed to reject a default reply. If an exit program rejects
the reply, a CPD2476 (Reply rejected by a reply handling exit
program) will be sent as a diagnostic message to the program
using this function. The CPD2476 will be followed by a
CPF2422 (Reply not valid) escape message that the program using
this function should monitor for to handle and recover from
error situations.
|
Note: If a default reply is not being sent, this parameter is ignored and a reply handling exit program can reject or replace the reply value.
If the inquiry message that this reply is being sent to is an impromptu message, the text supplied on the reply text parameter is assumed to be in the CCSID of the job executing this API unless the coded character set identifier is supplied in the CCSID parameter. If the inquiry message that this reply is being sent to is a predefined message, then the text supplied on the reply text parameter is considered 65535 and is not converted. For more information about message handler and its use of CCSIDs, see CCSID support for messages.
| Message ID | Error Message Text |
|---|---|
| CPF24A4 E | Value for remove message not valid. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF24B6 E | Length of &1, not valid for message text or data. |
| CPF2401 E | Not authorized to library &1. |
| CPF2403 E | Message queue &1 in &2 not found. |
| CPF2408 E | Not authorized to message queue &1. |
| CPF2410 E | Message key not found in message queue &1. |
| CPF2420 E | Reply already sent for inquiry or notify message. |
| CPF2422 E | Reply not valid. |
| CPF2432 E | Cannot send reply to message type other than *INQ or *NOTIFY. |
| CPF2433 E | Function not allowed for system log message queue &1. |
| CPF2439 E | Reply value entered is not valid. |
| CPF2440 E | Reply must be in range of &1 to &2. |
| CPF2442 E | Reply does not meet specified relations. |
| CPF2460 E | Message queue &1 could not be extended. |
| CPF2458 S | Reply replaced by reply handling exit program. |
| CPF2466 E | Reply length greater than &1. |
| CPF247E E | CCSID &1 is not valid. |
| CPF2477 E | Message queue &1 currently in use. |
| CPF2547 E | Damage to message file QCPFMSG. |
| CPF2548 E | Damage to message file &1 in &2. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C3A E | Value for parameter &2 for API &1 not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF8100 E | All CPF81xx messages could be returned. xx is from 01 to FF. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |