17.08.2013 Views

System i: Programming Message Handling APIs - IBM

System i: Programming Message Handling APIs - IBM

System i: Programming Message Handling APIs - IBM

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

*MNNR Only messages not requiring a reply are listed. This includes informational, completion,<br />

diagnostic, request, notify, escape, reply, answered inquiry, and answered sender’s copy messages.<br />

*MNR Only messages needing a reply are listed. This includes only unanswered inquiry messages.<br />

*PAR Only messages that can have problem analysis run against them are listed.<br />

*SCNR Only sender’s copy messages requiring a reply are listed. This includes only unanswered sender’s<br />

copy messages.<br />

Selection criteria specified. The selection criteria as specified on the call to the API.<br />

Sender type. This field can be specified for the QMHLSTM API, but it never returns any data and the<br />

length of data field is 0.<br />

Sending module name. This field can be specified for the QMHLSTM API, but it never returns any data<br />

and the length of data field is 0.<br />

Sending procedure name. This field can be specified for the QMHLSTM API, but it never returns any<br />

data and the length of data field is 0.<br />

Sending program name. The sending program name or ILE program name that contains the procedure<br />

sending the message. Under certain conditions, the actual name of the program that sent the message is<br />

not known. In these cases, this field contains the 6-byte hexadecimal address of the program converted<br />

into 12 displayable characters. In all other cases, the 10-character program name is returned left-justified<br />

in the field; the final 2 characters contain blanks.<br />

Sending statement numbers or instruction numbers. This field can be specified for the QMHLSTM API,<br />

but it never returns any data and the length of data field is 0.<br />

Sending user profile. The name of the user profile that the thread was running under when the message<br />

was sent.<br />

Severity criteria. The minimum severity of a message to be included in the list. The value must be<br />

between 0 and 99. To retrieve all messages, specify a severity criteria of 0.<br />

Severity criteria specified. The severity criteria as specified on the call to the API.<br />

Size of message selection information specified. The size of the message selection information field, in<br />

bytes, as specified in the call to the API.<br />

Starting message key. The message key used to begin searching for messages to list from the<br />

corresponding entry in the qualified message queue names field. You can use these special values for the<br />

message keys:<br />

’00000000’X The first message to be returned is the oldest message in the queue.<br />

’FFFFFFFF’X The first message to be returned is the newest message in the queue.<br />

If a value other than X’00000000’ or X’FFFFFFFF’ is specified and a message with that key does not exist,<br />

an error is returned.<br />

If the message that is specified by the starting message key exists but does not meet the selection criteria,<br />

the severity criteria, or the date and time criteria fields that are specified, no error is returned. The search<br />

for messages to list begins from the message that is specified by the starting message key.<br />

Starting message key specified. The starting message keys as specified on the call to the API.<br />

<strong>Message</strong> <strong>Handling</strong> <strong>APIs</strong> 45

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!