System i: Programming Message Handling APIs - IBM

*REMOVE Handles the escape, notify, or status exception and removes the message from the job log. If the
exception is a notify message, its default reply or the reply specified in the reply text parameter is
returned to the call stack entry that sent it. If the reply text length parameter value is 0, the default
reply is sent. No error message is returned if the exception is already handled. The exception is
immediately inaccessible for any further operations.
Reply text
INPUT; CHAR(*)
If the exception is a notify message that has already been replied to, it is handled and removed
from the job log. No error message is returned to the caller of this API.
If the exception is not a notify message, the reply text length parameter value must be 0. If the
reply text length parameter value is not 0, an error is returned to the caller of this API. The
exception is not handled or removed from the job log.
The data that is returned as the reply to a notify message when *REPLY or *REMOVE is specified
for the modification option parameter. This data must be compatible with the reply type, reply
length, and valid reply values stored in the message description for the message. If it is not
compatible, an error is returned to the caller of this API.
This parameter is ignored if:
v The message being changed is not a notify message.
v The modification option is not *REPLY or *REMOVE.
v The reply text length parameter is 0.
Reply text length
INPUT; BINARY(4)
The length, in bytes, of the data that is returned as the reply to a notify message. This length
must be compatible with the reply type and maximum reply length stored in the message
description for the message.
Valid values follow:
0 Return the notify message’s default reply.
1-132 Return the reply specified in the reply text parameter. This is the number of bytes to return.
If the message being changed is not a notify message, or the modification option is not *REPLY or
*REMOVE, this parameter is ignored.
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
CPF24A3 E Value for call stack counter parameter 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.
CPF2410 E Message key not found in message queue &1.
CPF2411 E Not authorized to message file &1 in &2.
CPF242D E Modification option &1 not valid.
CPF242E E Tried to change message which is not an exception.
CPF242F E Message type must be ESCAPE for *CHANGE modification option.
Message Handling APIs 5