System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

procedure name has each procedure name separated by a colon. The outermost procedure name is identified first followed by the procedures it contains. The innermost procedure is identified last in the string. Sending program name. The sending program name or ILE program name that contains the procedure sending the message. Sending user profile. The name of the user profile that the thread was running under when the message was sent. Size of message selection information specified. The size of the message selection information field, in bytes, as specified in the call to the API. Starting message key. The message key to begin searching for messages to list from the job. You can use these special values for the message key: ’00000000’X The first message to be returned is the oldest message in the queue. ’FFFFFFFF’X The first message to be returned is the newest message in the queue. When the list direction field is *NEXT, the first message listed is the first message with a message key equal to or greater than the key specified. If no message is found in this manner, an error is returned. When the list direction field is *PRV, the first message listed is the first message with a message key equal or less than the key specified. If no message is found in this manner, an error is returned. If a key of a reply message is specified, the message search begins with the inquiry, sender’s copy, or notify message with which the reply is associated. It does not begin with the reply message itself. Note: When a batch job is being listed, request messages that have not yet been processed or received are considered to have a sending date and time later than all other messages on the job log. This is also true for any diagnostic messages associated with those request messages. If the starting message key provided is to one of these messages, and the list direction is *NEXT, only additional request messages and associated diagnostic messages that remain to be processed are listed. If the list direction is *PRV, any earlier request messages or associated diagnostic messages are listed. These are followed by messages on the job log associated with request messages that have been or are being processed. Starting message key specified. The starting message key as specified on the call to the API. Starting message key used. The message keys of the first message actually listed by the API. If no message is listed, the value returned is the same as the value specified in the starting message key specified field. Status of data. The status of the data listed for this message. Possible values and their meanings follow: blank The data returned is complete. A The caller of the API was not authorized to view the data. This occurs when the caller of the API is not authorized to the message file or the message file library containing a stored message being listed. D The data was damaged. This occurs when the message file or library specified at send time for a stored message is damaged when the API is called. U The data was unavailable. This occurs when the message file or library specified at send time for a stored message is exclusively used by another process when the API is called. N The data was not found. This occurs when the message file or library specified at send time for a stored message cannot be found or resolved when the API is called. 28 System i: Programming Message Handling APIs
This field is applicable to the field identifiers that are retrieved from the message file for a stored message. A description of the action that occurs for specific field identifiers when the status of data field is not blank follows: 0101 When the status of data field is not blank, the alert option field identifier contains blanks. 0301, 0302 When the status of data field is not blank, these message field identifiers contain message text regarding the problem encountered while attempting to access the message file. Both fields have the replacement data substituted. 0401, 0402, 0403, 0404 When the status of data field is not blank, these message help field identifiers contain message text regarding the problem encountered while attempting to access the message file. All fields have the replacement data substituted. The message help with formatting characters and message help with replacement data and formatting characters field identifiers also have the message formatting characters included. 0501 When the status of data field is not blank, the default reply field identifier contains the system default reply. 0801 When the status of data field is not blank, the message file library used field identifier contains blanks. This field is also applicable to the various sending and receiving information fields when a problem is encountered while attempting to retrieve this information. This includes field identifiers 0602, 0603, 0604, 0605, 0606, 0702, 0703, 0704, 0705, and 0706. When one of these fields cannot be retrieved from the message, the status of data field is set to U and the field is set to blanks. The status of data field is always blank for the other field identifiers. Thread ID. The 8-byte thread ID of the thread in which this message was sent. Time sent. The time at which the message being listed was sent, in HHMMSS (hour, minute, and second) format. Type of data. The type of data returned. C The data is returned in character format. B The data is returned in binary format. M The data is returned in a mixed format. This value is returned for the field IDs 0606 and 0706, which contain a binary(4) value followed by an array of 10-character elements. User profile specified. The user profile of the job from which to list messages as specified on the call to the API. User profile used. The actual user profile of the job used from which to list messages. User space library specified. The name of the user space library as specified on the call to the API. User space library used. The actual name of the library where the user space was found. User space name specified. The name of the user space as specified on the call to the API. User space name used. The actual name of the user space used to store the data listed. Error Messages Message ID Error Message Text CPF1866 E Value &1 for number of fields to return not valid. CPF24B4 E Severe error while addressing parameter list. Message Handling APIs 29
Page 1: System i Programming Message Handli
Page 4 and 5: Note Before using this information
Page 6 and 7: Required Parameter Group . . . . .
Page 8 and 9: v “Receive Program Message (QMHRC
Page 10 and 11: n Change a message in the message q
Page 12 and 13: Message ID Error Message Text CPF24
Page 14 and 15: Required Parameter Group Output fil
Page 16 and 17: When a generic ID is specified, any
Page 18 and 19: CCSID of 65535 so conversion does n
Page 20 and 21: The List Job Log Messages (QMHLJOBL
Page 22 and 23: The format of the message selection
Page 24 and 25: Offset Dec Hex Type Field 62 3E CHA
Page 26 and 27: Identifier Type Description 0606 BI
Page 28 and 29: Coded character set identifier to r
Page 30 and 31: To list all messages in the job log
Page 32 and 33: Offset of fields to return specifie
Page 36 and 37: Message ID Error Message Text CPF24
Page 38 and 39: User space *CHANGE User space libra
Page 40 and 41: Header Section Offset Dec Hex Type
Page 42 and 43: Offset Dec Hex Type Field 0 0 BINAR
Page 44 and 45: 4 A conversion error occurred using
Page 46 and 47: Format of message selection informa
Page 48 and 49: Message queue library used. The act
Page 50 and 51: Qualified message queue names. The
Page 52 and 53: Starting message key used. The mess
Page 54 and 55: Move Program Messages (QMHMOVPM) AP
Page 56 and 57: *PGMBDY The call stack entry is for
Page 58 and 59: The length of the value for the to
Page 60 and 61: one that is addressed by the pointe
Page 62 and 63: specified in the user program, the
Page 64 and 65: *CURRENT The current day is the las
Page 66 and 67: Number of jobs to list. Specifies t
Page 68 and 69: Offset Dec Hex Type Field 116 74 BI
Page 70 and 71: Message type. The type of message l
Page 72 and 73: Differences between QMHLJOBL and QG
Page 74 and 75: Offset Dec Hex These fields repeat
Page 76 and 77: This field is also applicable to th
Page 78 and 79: If a key of a reply message is spec
Page 80 and 81: Coded character set identifier (CCS
Page 82 and 83: Replacement data or impromptu messa
Page 84 and 85:
3 List information Output Char(80)
Page 86 and 87:
1 Sort by the following message typ
Page 88 and 89:
Offset Dec Hex These fields repeat
Page 90 and 91:
0501 When the status of data field
Page 92 and 93:
Starting message keys. The message
Page 94 and 95:
2 No conversion occurred because yo
Page 96 and 97:
Receiving procedure name. This fiel
Page 98 and 99:
message. The message key of the new
Page 100 and 101:
*LERETRY Retry. The initial priorit
Page 102 and 103:
This parameter must specify the siz
Page 104 and 105:
see the Add Message Description (AD
Page 106 and 107:
Offset Dec Hex Type Field 8 8 BINAR
Page 108 and 109:
CCSID conversion status indicator f
Page 110 and 111:
Value Message Type 01 Completion 02
Page 112 and 113:
11 Length of call stack entry Input
Page 114 and 115:
stack entry on the call stack. The
Page 116 and 117:
v 1 through 4096 if partial name in
Page 118 and 119:
Optional You can either specify a m
Page 120 and 121:
Offset Dec Hex Type Field 45 2D CHA
Page 122 and 123:
Offset Dec Hex Type Field 53 35 CHA
Page 124 and 125:
CCSID of replacement data or improm
Page 126 and 127:
Value Message Type 01 Completion 02
Page 128 and 129:
Sending type. The type of the sende
Page 130 and 131:
*LIBL The library list Message key
Page 132 and 133:
diagnostic messages. This can preve
Page 134 and 135:
Messages to remove INPUT; CHAR(10)
Page 136 and 137:
Message ID Error Message Text CPF24
Page 138 and 139:
If the pointer is not Null or it do
Page 140 and 141:
If the pointer provided is not Null
Page 142 and 143:
*NONE This value can be used for th
Page 144 and 145:
The variable that receives informat
Page 146 and 147:
The coded character set identifier
Page 148 and 149:
Offset Dec Hex Type Field 52 34 BIN
Page 150 and 151:
Offset Dec Hex Type Field 228 E4 BI
Page 152 and 153:
0 No conversion was needed because
Page 154 and 155:
Length of relational test entry ava
Page 156 and 157:
*LT Less than *LE Less than or equa
Page 158 and 159:
Retrieve Message File Attributes (Q
Page 160 and 161:
Page 162 and 163:
Field Descriptions Allow alerts. Wh
Page 164 and 165:
Reserved. An ignored field. Text de
Page 166 and 167:
Offset Dec Hex Type Field 12 C CHAR
Page 168 and 169:
Page 170 and 171:
Qualified name of the reply message
Page 172 and 173:
Message File Library Authority *EXE
Page 174 and 175:
For an inquiry message only, the na
Page 176 and 177:
Page 178 and 179:
Message data 0-32767 Immediate text
Page 180 and 181:
v If the less than signs () are spe
Page 182 and 183:
*PGMBDY The call stack entry to sen
Page 184 and 185:
(QMHRCVPM) API specifying this key
Page 186 and 187:
Page 188 and 189:
The length of the reply text, in by
Page 190 and 191:
The Send Scope Message (QMHSNDSM) A
Page 192 and 193:
The Break Handling exit program pro
Page 194 and 195:
Receiving program type. The type of
Page 196 and 197:
The name of the message queue conta
Page 198 and 199:
function. The status message allows
Page 200 and 201:
The name of the message queue and l
Page 202 and 203:
v If an error occurs while retrievi
Page 204 and 205:
Sender’s copy (*COPY). Is a copy
Page 206 and 207:
IBM Corporation Software Interopera
Page 208 and 209:
SAA SecureWay SOM System i System i
Page 210:
204 System i: Programming Message H
show all

System i: Programming Message Handling APIs - IBM

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

Delete template?

Save as template?