System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

User space *CHANGE User space library *EXECUTE User space lock *EXCLRD Required Parameter Group Qualified user space name INPUT;CHAR(20) The user space that receives the generated list, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the user space library. You can use these special values for the library name: *CURLIB The job’s current library *LIBL The library list Format name INPUT; CHAR(8) The format of the returned message information. You must use this format: LSTM0100 Basic message information with identified return fields. This format is described in “LSTM0100 Format” on page 34. Message selection information INPUT; CHAR(*) The information that determines the message queues and messages to be listed. The format of this information is described in “MSLT0100 Format” on page 35 and in “MSLT0200 Format” on page 35. Size of message selection information INPUT; BINARY(4) The size, in bytes, of the message selection information parameter. Format of message selection information INPUT; CHAR(8) The format of the message selection information parameter. You must use one of these formats: MSLT0100 The specific information identifying the messages to be listed. This format is described in “MSLT0100 Format” on page 35. Message text and data are returned in the CCSID of your job. MSLT0200 The specific information identifying the messages to be listed. This format is described in “MSLT0200 Format” on page 35. This is the same as format MSLT0100 with the exception of the following: Error code I/O; CHAR(*) v You are able to specify the CCSID in which you wish your message text and data returned. v You may optionally specify a date and time with which to begin the list, relative to the beginning message key. The structure in which to return error information. For the format of the structure, see Error code parameter. 32 System i: Programming Message Handling APIs
Format of Generated Lists The user space created consists of: v A user area v A generic header v An input parameter section v A header section v LSTM0100 format For details about the user area and generic header, see User spaces. For details about the remaining items, see the following sections. For descriptions of each field in the list returned, see “Field Descriptions” on page 37. Input Parameter Section Offset Dec Hex Type Field 0 0 CHAR(10) User space name specified 10 A CHAR(10) User space library specified 20 14 CHAR(8) Format name specified 28 1C CHAR(8) Format of message selection information specified 36 24 BINARY(4) Size of message selection information specified 40 28 BINARY(4) Maximum messages requested specified 44 2C CHAR(10) List direction specified 54 36 CHAR(10) Selection criteria specified 64 40 BINARY(4) Severity criteria specified 68 44 BINARY(4) Maximum message length specified 72 48 BINARY(4) Maximum message help length specified 76 4C BINARY(4) Offset to message queue names specified 80 50 BINARY(4) Offset to starting message keys specified 84 54 BINARY(4) Number of message queues specified 88 58 BINARY(4) Offset to identifiers of fields to return specified 92 5C BINARY(4) Number of fields to return specified 96 60 BINARY(4) Coded character set identifier (CCSID) specified 100 64 CHAR(13) Date and time criteria specified 113 71 CHAR(*) Reserved The offsets to these fields are specified in the previous offset variables. ARRAY(*) of CHAR(20) ARRAY(*) of CHAR(4) ARRAY(*) of BINARY(4) Message queue names specified Starting message key specified Identifiers of fields to return specified Message Handling APIs 33
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 34 and 35: procedure name has each procedure n
Page 36 and 37: Message ID Error Message Text CPF24
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?