System i: Programming Message Handling APIs - IBM

If fewer messages than the number requested exist on the queues, only the number of messages that exist
are returned. No error is signaled, and the information status field in the generic header would be
marked as C for complete and accurate.
Use the special value of -1 to list all messages on the queues in the specified list direction. The list runs
from the starting message keys that meet the selection and severity criteria.
Maximum messages requested specified. The number of messages requested to be listed as specified on
the call to the API.
Message. The text of a predefined message without replacement data substitution. If an impromptu
message is listed, this field contains the impromptu message text.
Message file library specified at send time. The name of the library containing the message file as
specified when the message was sent. If *CURLIB or *LIBL was specified for the library when the
message was sent, that value is returned as the library here. For the actual library used when the
message is sent, see the message file library used field.
Message file library used. The actual name of the library that contains the message file used to retrieve
the message information. If an immediate message is listed, this field is set to blanks.
Message file name. The name of the message file containing the message listed.
Message help. The message help for the message listed without formatting characters and without
replacement data. If an impromptu message is listed, this field contains the impromptu message text.
Message help with formatting characters. The message help for the message listed, including formatting
characters.
Three format control characters can be returned within the message. They are defined in the online help
for the Add Message Description (ADDMSGD) command to have these meanings:
&N Forces the text to a new line (column 2). If the text is longer than one line, the next lines are indented to
column 4 until the end of text or another format control character is found.
&P Forces the text to a new line indented to column 6. If the text is longer than one line, the next lines start
in column 4 until the end of text or another format control character is found.
&B Forces the text to a new line, starting in column 4. If the text is longer than one line, the next lines are
indented to column 6 until the end of text or another format control character is found.
If an impromptu message is listed, this field contains the impromptu message text.
Message help with replacement data. The message help for the message listed, including the
replacement data. If an impromptu message is listed, this field contains the impromptu message text.
Message help with replacement data and formatting characters. The message help for the message
listed, including the replacement data and the formatting characters. See the message help with
formatting characters field for an explanation of formatting characters. If an impromptu message is listed,
this field contains the impromptu message text.
Message identifier. The identifying code of the message listed. If an impromptu message is listed, this
field is set to blanks.
Message key. The key of the message listed.
Message queue. The name of the message queue where the message was listed.
Message Handling APIs 41