System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

CCSID of 65535 so conversion does not occur on this field when the record is written. CCSID processing is done on the message data when the message is sent. The CCSID that the QMHMDT field data is in is stored in the record with the message data. The CCSID is placed in field QMHCID. CCSID conversion is allowed for any field in the secondary file except for the field QMHLIN which contains a line of message text. This field is defined with CCSID 65535. The message text has completed CCSID processing before the record is written to the file. The CCSID the message text is in is stored in field QMHSID. The model files QAMHJLPR and QAMHJLSC specify no CCSID definitions other than the two fields mentioned previously. CCSID processing for the remaining fields is allowed to default. For detailed information about the fields mentioned in this discussion, see CL programming topic. Error Considerations During job log production to an output file, different types of errors can be encountered. Some errors allow the job log to be written to the output file but the information in a record can be incomplete. Other errors can prevent the job log from being written to the output file. For example, when the output file has been deleted between the time this API has been run and job log production starts. Other errors, such as when a member becomes full, allow a certain number of records to be written but not all. Whenever an error is encountered, an informational message is written to the user or workstation queue specified by the API parameter. If the API parameter specifies *NONE, these messages are not written. If the error is such that the data can still be written to the output file, even though it can be incomplete, processing continues and at the end of job log production there are output file(s) and member(s) which contains the information that could be written. For example, if the message data for a message needs to be truncated to 3000 characters, production of the job log to the output file continues but a message is sent to record the fact that the message data was truncated. If the error is such that no data can be written, the job log automatically redirects to a spooled file. This occurs if the objects, determined by the API to be the output files, are deleted, damaged, or otherwise unusable at the time job log production started. If any such error is encountered on the primary or secondary output file, this redirection to a spooled file occurs. A message is sent to the specified message queue to record that the job log has been redirected to a spooled file. If only certain records are written to the output file, the remaining messages are redirected to a spooled file. A message is sent to notify of this. Job Message Queue Full Considerations If the print-wrap option is used to control the action to take when a job message queue becomes full, consider the following when using this API to direct the output to an output file. Each time the job message queue becomes full, records are written to the output file for those messages that are being removed from the job message queue. All new records are added to the member. The Member replace option specified on this API has an effect only when this API is preparing the output file for use. It has no effect when the records are written to the output file. For the print-wrap option, the member contains the complete set of messages for the job rather than a partial set. For long running jobs, it is possible that the job message queue can become full and the output file member also becomes full. If the member becomes full, output is automatically redirected to a spooled file until the API is run another time to specify a new member to use. Changing the action from print-wrap to wrap will stop the production of records to the file(s). When the job ends or if the action is changed back to print-wrap, records are again written to the file(s). 12 System i: Programming Message Handling APIs
Usage Notes This API can be called from the initial thread of a multithreaded job to control the job log output for all threads. It should not be called from a secondary thread. Error Messages Message ID Error Message Text CPF24D0 E QTEMP is not a valid library to use for the file &1. CPF24D1 E Member replace option &1 is not valid. CPF24D2 E Number of elements &1 in message filter array is not valid. CPF24D3 E Message queue &1 not valid for use with the QMHCTLJL API. CPF24D4 E Message type &1 specified in filter element &2 is not valid. CPF24D5 E Message severity &1 specified in filter element &2 is not valid. CPF24D6 E Reserved field in filter element &1 does not contain a null value. CPF24D7 E File &1 in library &2 cannot be used for job log production. CPF24D8 E DDM file &1 in library &2 cannot be used for job log production. CPF24D9 E Error message queue library name &1 is not valid. CPF24DA E Failure while preparing for job log production to a physical file. CPF3CF1 E Error code parameter not valid. CPF3C1D E Length specified in parameter &1 not valid. CPF3C21 E Format name &1 is not valid. CPF3C90 E Literal value cannot be changed. CPF9822 E Not authorized to file &1 in library &2. CPF9872 E Program or service program &1 in library &2 ended. Reason code &3. Job Log Production Messages Message ID Message Text CPD241A E Output file &1 member &3 moved or renamed. CPD241B E Error occurred on file &1 member &3 in &2. CPD241C E Job log file &1 member &3 in &2 has been deleted. CPD241D E Job log file &1 member &3 in &2 is not available. CPD241E E No records written to job log file &1 member &3 in &2. CPD241F E Not all records written to job log file &1 member &3 in &2. CPD242B E Message data truncated for message key &7. API introduced: V3R1 Top | “Message Handling APIs,” on page 1 | APIs by category List Job Log Messages (QMHLJOBL) API Required Parameter Group: 1 Qualified user space name Input Char(20) 2 Format name Input Char(8) 3 Message selection information Input Char(*) 4 Size of message selection information Input Binary(4) 5 Format of message selection information Input Char(8) 6 Error code I/O Char(*) Default Public Authority: *USE Threadsafe: No Message Handling APIs 13
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 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 34 and 35: procedure name has each procedure n
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

Create successful ePaper yourself

Delete template?

Save as template?