System i: Programming Message Handling APIs - IBM

More documents

Recommendations

Info

v “Receive Program Message (QMHRCVPM) API” on page 105 (QMHRCVPM) receives a message from a call message queue, and provides information about the sender of the message as well as the message itself. This API is similar in function to the Receive Message (RCVMSG) command with the PGMQ parameter. v “Remove Nonprogram Messages (QMHRMVM) API” on page 123 (QMHRMVM) removes messages from nonprogram message queues. This API is similar in function to the Remove Message (RMVMSG) command with the MSGQ parameter. v “Remove Program Messages (QMHRMVPM) API” on page 125 (QMHRMVPM) removes messages from call message queues. This API is similar in function to the Remove Message (RMVMSG) command with the PGMQ parameter. v “Resend Escape Message (QMHRSNEM) API” on page 130 (QMHRSNEM) resends an escape message from one call message queue to the message queue of the previous call stack entry in the call stack. v “Retrieve Message (QMHRTVM) API” on page 137 (QMHRTVM) retrieves the message text and other elements of a predefined message stored in a message file on your system. This API is similar to the Retrieve Message (RTVMSG) command. v “Retrieve Message File Attributes (QMHRMFAT) API” on page 152 (QMHRMFAT) retrieves information about the attributes of a message file. v “Retrieve Nonprogram Message Queue Attributes (QMHRMQAT) API” on page 154 (QMHRMQAT) provides information about the attributes of a nonprogram message queue. v “Retrieve Request Message (QMHRTVRQ) API” on page 158 (QMHRTVRQ) retrieves request messages from the current job’s call message queue. v “Send Break Message (QMHSNDBM) API” on page 162 (QMHSNDBM) sends a message to a workstation for immediate display, interrupting the workstation user’s task. You can use break messages to warn users of impending system outages and the like. This API is similar in function to the Send Break Message (SNDBRKMSG) command. v “Send Nonprogram Message (QMHSNDM) API” on page 165 (QMHSNDM) sends a message to a system user or a message queue that is not associated with a specific program. This API is similar in function to the Send Program Message (SNDPGMMSG) command with the TOMSGQ parameter. v “Send Program Message (QMHSNDPM) API” on page 170 (QMHSNDPM) sends a message to the message queue of a call stack entry in the call stack. This API is similar in function to the Send Program Message (SNDPGMMSG) command with the TOPGMQ parameter. v “Send Reply Message (QMHSNDRM) API” on page 180 (QMHSNDRM) sends a response to an inquiry message. This API is similar in function to the Send Reply (SNDRPY) command. v “Send Scope Message (QMHSNDSM) API” on page 183 (QMHSNDSM) Sends a scope message that allows a user to specify a program to run when your program or job is completed. The message handling exit programs are: v “Break Handling Exit Program” on page 185 provides the capability of handling messages that arrive at a message queue that is in *BREAK mode. v “Default Handling Exit Program” on page 186 provides a default message handling action that can be used if the program that is signaled an escape message does not monitor for or handle the escape message. v “Inquiry Handling Exit Program” on page 188 (QIBM_QMH_HDL_INQEXT) is called in an interactive job when an inquiry message has been sent to *EXT and the job would be interrupted by the Display Program Messages screen to obtain a reply. The exit program can send a reply to the inquiry message, so the interactive user is not interrupted to provide a reply to the inquiry message. v “Reply Handling Exit Program” on page 191 (QIBM_QMH_REPLY_INQ) is called when a reply is sent to an inquiry message. 2 System i: Programming Message Handling APIs Top | APIs by category
APIs These are the APIs for this category. Change Exception Message (QMHCHGEM) API Required Parameter Group: 1 Invocation pointer Input Pointer 2 Call stack counter Input Binary(4) 3 Message key Input Char(4) 4 Modification option Input Char(10) 5 Reply text Input Char(*) 6 Reply text length Input Binary(4) 7 Error code I/O Char(*) Default Public Authority: *USE Threadsafe: Yes The Change Exception Message (QMHCHGEM) API changes an exception message on a call message queue. This API allows the current program to perform one of the following actions on an exception message that was sent to its caller, a previous caller, or itself: v Handle the escape, status, or notify message. If the exception is a notify message that has not already received a reply, return the default reply. v If it is a notify message that has not been replied to, return a reply to the call stack entry that sent this message. Handle the exception. v Handle the escape, status, or notify message and remove it from the job log. If the exception is a notify message that has not been replied to, return its default reply or another reply to the call stack entry that sent it. Authorities and Locks None. Required Parameter Group Invocation pointer INPUT; POINTER The invocation pointer to the call stack entry to which the exception message was sent. When using a value other than 0 for the call stack counter parameter, the invocation pointer points to the call stack entry from which to start counting in the call stack. This is the location of the call stack entry that received the exception message that was sent. The call stack entry you specify must be in the call stack. A null invocation pointer may be specified. If this pointer is not set, the call stack entry that called the QMHCHGEM API is used. Call stack counter INPUT; BINARY(4) A number that identifies the location in the call stack of the call stack entry that received the message you are changing. The number is relative to the call stack entry specified in the invocation pointer parameter. The number indicates how many calls earlier in the call stack the call stack entry is from the one specified in the invocation pointer parameter. Valid values follow: 0 Change a message in the message queue of the call stack entry specified in the invocation pointer parameter. 1 Change a message in the message queue of the call stack entry that called the call stack entry specified in the invocation pointer parameter. Message Handling APIs 3
Page 1: System i Programming Message Handli
Page 4 and 5: Note Before using this information
Page 6 and 7: Required Parameter Group . . . . .
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 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?