System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

Identifier Type Description 0606 BINARY(4) followed by ARRAY(*) of CHAR(10) 0607 CHAR(10) Sending user profile 0702 CHAR(1) Receiving type 0703 CHAR(10) Receiving program name 0704 CHAR(10) Receiving module name 0705 CHAR(*) Receiving procedure name 0706 BINARY(4) followed by ARRAY(*) of CHAR(10) 0801 CHAR(10) Message file library used 0901 CHAR(30) Problem identification 1001 CHAR(1) Reply status 1101 CHAR(1) Request status 1201 BINARY(4) Request level Number of sending statement numbers or instruction numbers available followed by an array of the sending statement numbers or instruction numbers Number of receiving statement numbers or instruction numbers available followed by an array of the receiving statement numbers or instruction numbers 1301 BINARY(4) Coded character set identifier (CCSID) for text 1302 BINARY(4) CCSID conversion status indicator for text 1303 BINARY(4) Coded character set identifier (CCSID) for data 1304 BINARY(4) CCSID conversion status indicator for data Field Descriptions Alert option. Whether and when an SNA alert is created and sent for the message. The value is one of the following: *DEFER An alert is sent after local problem analysis. *IMMED An alert is sent immediately when the message is sent to a message queue that has the allow alerts attribute set to *YES. *NO No alert is sent. *UNATTEND An alert is sent immediately when the system is running in unattended mode (when the value of the alert status network attribute, ALRSTS, is *UNATTEND). For more information about alerts, see the Alerts Support manual. This field is set to blanks if no alert option was specified when the message was sent. Call message queue name. The name of the call message queue from which the messages are listed. You must use one of these values: * Messages from every call stack entry of the job are listed. If the length of call message queue name field is greater than 1, the value must be left-justified and padded on the right with blanks. *EXT Only messages sent to the external message queue (*EXT) of the job are to be listed. If the length of the call message queue name field is greater than 4. The value must be left-justified in the field and padded on the right with blanks. Call message queue specified. The call message queue name as specified on the call to the API. 20 System i: Programming Message Handling APIs
CCSID conversion status indicator for data. The following values may be returned: 0 No conversion was needed because the CCSID of the data matched the CCSID you wanted the data converted to. 1 No conversion occurred because either the data was 65535 or the CCSID you wanted the data converted to was 65535. 2 No conversion occurred because you did not ask for any message data to be returned or the data did not contain any *CCHAR type data. 3 The data was converted to the CCSID specified using the best fit conversion tables. 4 A conversion error occurred using the best fit conversion tables so a default conversion was attempted. This completed without error. -1 An error occurred on both the best fit and default conversions. The text was not converted. CCSID conversion status indicator for text. The following values may be returned: 0 No conversion was needed because the CCSID of the text matched the CCSID you wanted the text converted to. 1 No conversion occurred because either the text was 65535 or the CCSID you wanted the text converted to was 65535. 2 No conversion occurred because you did not ask for any text to be returned. 3 The text was converted to the CCSID specified using the best fit conversion tables. 4 A conversion error occurred using the best fit conversion tables so a default conversion was attempted. This completed without error. -1 An error occurred on both the best fit and default conversions. The data was not converted. Coded character set identifier (CCSID) for data. The coded character set identifier that the replacement data is returned in. This only applies to the part of the replacement data that corresponds to a convertible character data type (*CCHAR). All other replacement data will not be converted before it is returned and can be considered to have a CCSID of 65535. If a conversion error occurs or if the CCSID you requested the data to be converted to is 65535, the CCSID of the data is returned. If there is no *CCHAR replacement data, 65535 is returned. Otherwise the CCSID you wanted the data converted to is returned. For more information about message handler and its use of CCSIDs, see CCSID support for messages. For more information about the *CCHAR field type, see the Add Message Description (ADDMSGD) command. Coded character set identifier (CCSID) for text. The coded character set identifier that the message text is returned in. If a conversion error occurs or if the CCSID you requested the message text to be converted to is 65535, the CCSID that the message text is stored in is returned. Otherwise the CCSID you wanted your message text converted to is returned. If you do not want the text converted before it is returned to you but you do want to know the CCSID that the message text is stored in, specify 65535 on the coded character set identifier to return text and data in parameter. The CCSID that the message text is stored in is returned in the coded character set identifier for text output field. This applies to the following fields only: v Message v Message with replacement data v Message help v Message help with replacement data v Message help with replacement data and formatting characters v Message help with formatting characters Note: This CCSID value does not apply to the replacement data that has been substituted into the text. See the coded character set identifier for data for this information. Message Handling APIs 21
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 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?