System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

Coded character set identifier to return text and data in. The CCSID that the text and data are converted to before they are returned. The following values are allowed: 0 The text and data are converted to the CCSID of the job before being returned. This is the default value used when the JSLT0100 format is specified. If the job is 65535 and the text or data is something other than EBCDIC single byte or EBCDIC mixed, the text and data are converted to the default job CCSID. 65535 The text and data are not converted before being returned. CCSID Specify a valid CCSID you want your text and data converted to before being returned. The CCSID must be between 1 and 65535. The CCSID is validated by this API. Only CCSIDs that a job can be changed to are accepted. For a list of valid CCSIDs, see CCSID support for messages. Coded character set identifier specified. The CCSID that was specified that the text and data are converted to before they are returned. Coded character set identifier used. The CCSID that was used that the text and data are converted to before they are returned. Data. The data returned for the specified identifier field. Date sent. The date on which the message was sent, in CYYMMDD (century, year, month, and day) format. Default reply. The text of the default reply when a stored message is being listed and a default reply exists. If this is not an inquiry message, or no default reply exists, this field is not used and the length of data field is 0. Ending message key. The message key of the last 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. Format of message selection information specified. The format name of the message selection information parameter as specified on the call to the API. Format name specified. The format name as specified on the call to the API. Identifier field. The field ID actually returned in the LJOB0100 format. See “Valid Field Identifiers” on page 19 for the list of valid field identifiers. Identifiers of fields to return. The list of the field identifiers returned in the LJOB0100 format. For a list of the valid field identifiers, see “Valid Field Identifiers” on page 19. Identifiers of fields to return specified. The list of identifiers of fields to return as specified on the call to the API. Internal job identifier. The internal name for the job. The List Job (QUSLJOB) API creates this identifier. If you do not specify *INT for the qualified job name parameter, this parameter must contain blanks. If your application already has this information available from QUSLJOB, the QMHLJOBL API can locate the job more quickly with this information than with a job name. However, calling QUSLJOB solely to obtain this parameter for use by QMHLJOBL would result in poorer performance than using a job name in calling QMHLJOBL. Internal job identifier specified. The internal job identifier as specified on the call to the API. Job name specified. The job name of the job that lists the messages as specified on the call to the API. 22 System i: Programming Message Handling APIs
Job name used. The actual job name of the job that was used to list the messages. Job number specified. The job number of the job that lists the messages as specified on the call to the API. Job number used. The actual job number of the job that was used to list the messages. Length of data. The length of the data returned for the data field, in bytes. Length of field information returned. The total length of information returned for this field, in bytes. Length of call message queue name. The length of the call message queue name field, in bytes. The maximum length that can be specified is 256. The minimum length is 1. Length of call message queue specified. The length of the call message queue specified field, in bytes. List direction. The direction to list messages. You must use one of these directions: *NEXT Returns messages that are newer than the message specified by the starting message key field. *PRV Returns messages that are older than the messages specified by the starting message key field. 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. List direction specified. The direction to list messages as specified on the call to the API. Maximum message help length. The maximum number of characters of text that this API returns for field identifiers 0401, 0402, 0403, and 0404. (See “Valid Field Identifiers” on page 19.) Specify a value to limit the number of characters returned for field identifiers 0401, 0402, 0403, and 0404. This value can be no smaller than 4. The maximum allowed value is 32765. To specify that the maximum length be used, use the special value of -1. This value is not checked if field identifiers 0401, 0402, 0403 or 0404 are not specified. Maximum message help length specified. The maximum number of characters to return for field identifiers 0401, 0402, 0403 and 0404 as specified on the call to the API. Maximum message length. The maximum number of characters of text that this API returns for field identifiers 0301 and 0302. Specify a value to limit the number of characters returned for field identifiers 0301 and 0302. (See “Valid Field Identifiers” on page 19.) This value can be no smaller than 4. The maximum allowed value is 32765. To specify that the maximum length be used, use the special value -1. This value is not checked if field identifiers 0301 or 0302 are not specified. Maximum message length specified. The maximum number of characters to return for field identifiers 0301 and 0302 as specified on the call to the API. Maximum messages requested. The maximum number of messages to be returned. If fewer messages than the number requested exist on the job message queue, only the number of messages that exist are returned. No error is signaled, and the information status field in the generic header would be marked as C for complete and accurate. Message Handling APIs 23
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 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?