System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

Required Parameter Group Output file names structure INPUT; CHAR(65) Provides information about the primary and secondary files and members. Output file names structure format INPUT; CHAR(8) The format of the output file names structure parameter. This must be set to CTLJ0100. See “CTLJ0100 Output File Names Structure” on page 9 for details about this format. Message filter array INPUT; CHAR(*) An array of zero or more elements. Each element in the array defines a test applied against each message before it is written to the output file. The tests are performed in the order they appear in the array. A message is rejected and not written to the output file if any one test defined in the array is true for the message. A message is selected and written to the output file if all tests defined in the array are false for the message. Each array element specifies a message severity, message type, and message ID. If a message has a message severity less than or equal to the specified severity, has the specified type, and has a message ID equal to the specified ID, the test is true and the message is not written to the output file. Processing stops on the rejected message and the next message is processed. If a message meets one or two of the criteria but not all three, the test is false and the test defined by the next array element is applied. If all array elements have been applied to the message and none have been found true, the message is written to the output file. Number of message filter elements INPUT; BINARY(4) The number of elements in the Message filter array parameter. The value must be greater than or equal to 0 but less than or equal to 255. If no message filtering is to be done during job log production, this parameter must be set to 0. Qualified error message queue name INPUT; CHAR(20) The qualified name of a message queue to which a message should be sent to record any errors detected during the production of the job log to an output file. The first 10 characters of this parameter contain the message queue name and the second 10 characters contain the library name. A library name must be specified. The special values *CURLIB and *LIBL cannot be used. QTEMP cannot be specified as the library name. The message queue name specified cannot be QHST or QSYSMSG. The following special value can be used for the message queue name of this parameter: *NONE No messages are sent. If errors occur during job log production to an output file, there is no record of what the error was or the action taken in response to the error. *SYSOPR Send the messages to the system operator’s message queue, QSYSOPR. If a qualified message queue name is provided and that message queue does not exist or is unusable at job log production time, any messages are sent to *SYSOPR. Error code I/O; CHAR(*) The structure in which to return error information. For the format of the structure, see Error code parameter. 8 System i: Programming Message Handling APIs
CTLJ0100 Output File Names Structure The following table shows the layout of the output file names structure for format CTLJ0100. Offset Dec Hex Type Field 0 0 BIN(4) Output file names structure length 4 4 CHAR(20) Qualified primary file name 24 18 CHAR(10) Primary file member name 34 22 CHAR(20) Qualified secondary file name 54 36 CHAR(10) Secondary file member name 64 40 CHAR(1) Member replace option Message Filter Array Elements The following table shows the structure of an array element in the message filter array parameter. This structure is repeated for each element in the array. Offset Dec Hex Type Field 0 0 CHAR(4) Reserved 4 4 BINARY(4) Message severity 8 8 CHAR(10) Message Type 18 12 CHAR(7) Message ID 25 19 CHAR(3) Reserved Field Descriptions Member replace option. Specifies if an existing member of either the primary or secondary file is to be cleared. If the member is to be cleared, it is cleared when this API is called. If a member contains existing records and is not cleared, at job log production time, the new records are added to the member and the existing records are left unchanged. Use one of the following special values: 0 Do not clear the member. 1 Clear the member of existing records. Message ID. The message ID to test each message against. The following special values can be used in place of a message ID: *ANY Any message ID is considered equal. Message type and message severity determine if the message is selected or rejected. If message type is specified as *ANY, message severity as 99, and message ID as *ANY, all messages are rejected. There is no job log output to the output file(s). *IMMED Identifies immediate messages with no message ID. A generic message ID can be used in place of a specific message ID. A generic message ID is an ID in which the last 2 or 4 characters are 0. For example, CPF2400 and CPF0000 are generic IDs. A generic ID represents a range of IDs rather than a single ID. A generic ID of the form XXXnn00 represents all IDs from XXXnn00 through XXXnnFF. A generic ID of the form XXX0000 represents all IDs from XXX0000 through XXXFFFF. Message Handling APIs 9
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 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 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?