friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/xwchevnt.htm

908 lines
30 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Exit Program for Watch for Event</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records -->
<!-- Created for V5R4 by Sergio Toscano (stlomeli) DCR 99930 -->
<!-- d3602 v5r4m0 Sergio Toscano 041003 + Add note to msg timestamp -->
<!-- indicating that it might not-->
<!-- match the time in the joblog-->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2><img src="delta.gif" alt="Start of change">Exit Program for Watch for Event</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Watch option setting</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Session ID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Error detected</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Event data</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;QSYSINC/H member name: ESCWCHT<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Watch for event functionality is started by the STRWCH command or the
Start Watch (QSCSWCH) API, and has the capability to notify the user by
calling a user exit program when the specified event occurs.
An event can be a message being sent to a message queue, job log, or LIClog.
The user-written program will be called in the cicumstances
specified in the Watch option setting parameter.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Watch option setting</strong></dt>
<dd>INPUT; CHAR(10)
<p>The reason indicating why the user-written program was called.
The possible values are:</p>
<table border cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left">*MSGID</td>
<td align="left">A match on a message id and any associated comparison data specified on watch for message
parameter occurred.</td>
</tr>
<tr>
<td align="left">*LICLOG</td>
<td align="left">A match on a LIC log and any associated comparison data specified
on the watch for LIC Log entry parameter occurred.</td>
</tr>
</table>
<br>
</dd>
</dl>
<dl>
<dt><strong>Session ID</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the session that is calling the exit program.</p>
<br>
</dd>
</dl>
<dl>
<dt><strong>Error detected</strong></dt>
<dd>OUTPUT; CHAR(10)
<p>Indicates if an error on the user-written program was found.</p>
<p>The possible values are:</p>
<table border cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left">*ERROR</td>
<td align="left">Error detected by watch exit program. The watch session that was passed in Session ID
parameter will be ended. If the watch session to be ended originally specified multiple
message ids or LIC log entries, all of them will no longer be watched.</td>
</tr>
<tr>
<td align="left">&lt;blanks&gt;</td>
<td align="left">No error detected by watch exit program.</td>
</tr>
</table>
<br>
<p><strong>Note:</strong> Any value other than "*ERROR" or &lt;blanks&gt; will be considered an error
and the watch session that was passed in Session ID parameter will be ended. If the watch
session to be ended originally specified multiple message ids or LIC log entries, all of them
will no longer be watched.</p>
</dd>
</dl>
<dl>
<dt><strong>Event data</strong></dt>
<dd>INPUT; CHAR(*)
<p>The format of the watch information depends on the Watch option setting causing the
exit program to be called.</p>
<p>The format of the Event data is as follows if the Watch option
setting is *MSGID:</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of trace information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Message ID</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue name</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message queue library</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job user name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(256)</td>
<td align="left" valign="top">Sending program name</td>
</tr>
<tr>
<td align="center" valign="top">318</td>
<td align="center" valign="top">13E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Sending module name</td>
</tr>
<tr>
<td align="center" valign="top">328</td>
<td align="center" valign="top">148</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to sending procedure name</td>
</tr>
<tr>
<td align="center" valign="top">332</td>
<td align="center" valign="top">14C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of sending procedure name</td>
</tr>
<tr>
<td align="center" valign="top">336</td>
<td align="center" valign="top">150</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Receiving program name</td>
</tr>
<tr>
<td align="center" valign="top">346</td>
<td align="center" valign="top">15A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Receiving module name</td>
</tr>
<tr>
<td align="center" valign="top">356</td>
<td align="center" valign="top">164</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">360</td>
<td align="center" valign="top">168</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">364</td>
<td align="center" valign="top">16C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Message severity</td>
</tr>
<tr>
<td align="center" valign="top">368</td>
<td align="center" valign="top">170</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message type</td>
</tr>
<tr>
<td align="center" valign="top">378</td>
<td align="center" valign="top">17A</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Message timestamp</td>
</tr>
<tr>
<td align="center" valign="top">386</td>
<td align="center" valign="top">182</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Message key</td>
</tr>
<tr>
<td align="center" valign="top">390</td>
<td align="center" valign="top">186</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message file name</td>
</tr>
<tr>
<td align="center" valign="top">400</td>
<td align="center" valign="top">190</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Message file library</td>
</tr>
<tr>
<td align="center" valign="top">410</td>
<td align="center" valign="top">19A</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">412</td>
<td align="center" valign="top">19C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to comparison data</td>
</tr>
<tr>
<td align="center" valign="top">416</td>
<td align="center" valign="top">1A0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of comparison data</td>
</tr>
<tr>
<td align="center" valign="top">420</td>
<td align="center" valign="top">1A4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Compare Against</td>
</tr>
<tr>
<td align="center" valign="top">430</td>
<td align="center" valign="top">1AE</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">432</td>
<td align="center" valign="top">1B0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Comparison data CCSID</td>
</tr>
<tr>
<td align="center" valign="top">436</td>
<td align="center" valign="top">1B4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset where comparison data was found</td>
</tr>
<tr>
<td align="center" valign="top">440</td>
<td align="center" valign="top">1B8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to replacement data</td>
</tr>
<tr>
<td align="center" valign="top">444</td>
<td align="center" valign="top">1BC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of replacement data</td>
</tr>
<tr>
<td align="center" valign="top">448</td>
<td align="center" valign="top">1C0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Replacement data CCSID</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Sending procedure name</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Message comparison data</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Message replacement data</td>
</tr>
</table>
<br>
<p>The format of the Event data is as follows if the Watch option
setting is *LICLOG:</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="left" valign="bottom">Dec</th>
<th align="left" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of trace information</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">LIC Log major code</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">LIC Log minor code</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">LIC Log identifier</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">LIC Log timestamp</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">TDE number</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Task name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Server type</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Exception ID</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">LIC job name</td>
</tr>
<tr>
<td align="center" valign="top">94</td>
<td align="center" valign="top">5E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">LIC job user name</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">LIC job number</td>
</tr>
<tr>
<td align="center" valign="top">110</td>
<td align="center" valign="top">6E</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">114</td>
<td align="center" valign="top">72</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Thread ID</td>
</tr>
<tr>
<td align="center" valign="top">122</td>
<td align="center" valign="top">7A</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">LIC module compile timestamp</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">LIC module offset</td>
</tr>
<tr>
<td align="center" valign="top">138</td>
<td align="center" valign="top">8A</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">LIC module RU name</td>
</tr>
<tr>
<td align="center" valign="top">146</td>
<td align="center" valign="top">92</td>
<td align="left" valign="top">CHAR(48)</td>
<td align="left" valign="top">LIC module name</td>
</tr>
<tr>
<td align="center" valign="top">194</td>
<td align="center" valign="top">DA</td>
<td align="left" valign="top">CHAR(128)</td>
<td align="left" valign="top">LIC module entry point name</td>
</tr>
<tr>
<td align="center" valign="top">322</td>
<td align="center" valign="top">142</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">324</td>
<td align="center" valign="top">144</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to comparison data</td>
</tr>
<tr>
<td align="center" valign="top">328</td>
<td align="center" valign="top">148</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of comparison data</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">LIC Log comparison data</td>
</tr>
</table>
<br>
</dd>
</dl>
<br>
<h3><a name="Header_9"></a>Field Descriptions</h3>
<p><strong>Compare against.</strong> The part of the message the data specified
in message comparison data field was compared against. This field is set to
blanks if zero was specified for the length of comparison data field.
The possible values are:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*MSGDTA</em></td>
<td align="left" valign="top">The message comparison data was compared against
the message replacement data.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FROMPGM</em></td>
<td align="left" valign="top">The message comparison data was compared against the
sending program name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TOPGM</em></td>
<td align="left" valign="top">The message comparison data was compared against the
receiving program name.</td>
</tr>
</table>
<br>
<p><strong>Comparison data CCSID.</strong> The coded character set identifier (CCSID)
of the message comparison data.</p>
<p><strong>Exception ID.</strong> The exception that caused the LIC log entry to
be requested. This is a 2-byte hexadecimal field formed by concatenating to the
high-order 1-byte exception group number a low-order 1-byte exception subtype number.
Exception identifier is binary zeros if the LIC log entry was not
requested as a result of an exception.</p>
<p><strong>Job name.</strong> The name of the job that sent the message.</p>
<p><strong>Job number.</strong> The job number (000001-999999) to further qualify the job
name and user name of the job that sent the message.</p>
<p><strong>Job user name.</strong> The user name of the job that sent the message.</p>
<p><strong>Length of watch information.</strong> The length of the Event data
parameter passed to the user-written exit program, including the 4-byte length
of this field.</p>
<p><strong>Length of comparison data.</strong> The length of the user specified text
to be compared against the message or LIC log event data.</p>
<p><strong>Length of receiving procedure name.</strong> The length of the procedure
the message was sent to when the message was sent to a procedure within an ILE program.
This field is set to zero if the message was sent to an original program model (OPM)
program or when the message is sent to a nonprogram message queue.</p>
<p><strong>Length of replacement data.</strong> The length of the message replacement
data, in bytes.</p>
<p><strong>Length of sending procedure name.</strong> The length of the procedure
sending the message when the message was sent from a procedure within an ILE program.
This field is set to zero if the message was sent from an original program model
(OPM) program.</p>
<p><strong>LIC job name.</strong> The name of the job which requested the LIC log
entry. LIC job name is blank (hex 40s) if the LIC log entry was not requested by
a job.</p>
<p><strong>LIC job number.</strong> The job number (000001-999999) to further qualify
the job name and user name of the job which requested the LIC log entry. LIC job
number is blank (hex 40s) if the LIC log entry was not requested by a job.</p>
<p><strong>LIC job user name.</strong> The user name of the job which requested the
LIC log entry. LIC user name is blank (hex 40s) if the LIC log entry was not
requested by a job.</p>
<p><strong>LIC Log identifier.</strong> The LIC Log entry identifier of the LIC Log
that occurred. The LIC log entry identifier is binary zeros if the entry was not
added to the LIC log by the time this event was signaled.</p>
<p><strong>LIC Log major code.</strong> The major code of the LIC Log that occurred.</p>
<p><strong>LIC Log minor code.</strong> The minor code of the LIC Log that occurred.</p>
<p><strong>LIC Log comparison data.</strong> The user specified text string used
to compare against the entry data of the watched for LIC log entry.</p>
<p><strong>LIC Log timestamp.</strong> The timestamp of when the entry was requested
to be added to the LIC log. The format for this field is the system time-stamp format.
The Convert Date and Time Format (QWCCVTDT) API can be used to convert a time-stamp
value to character format.</p>
<p><strong>LIC module compile timestamp.</strong> The timestamp of when the LIC module
was compiled. The format for this field is the system time-stamp format.</p>
<p><strong>LIC module offset.</strong> The byte offset into the LIC module text which
requested the LIC log entry.</p>
<p><strong>LIC module RU name.</strong> The replaceable unit name of the module which
requested the LIC log entry. LIC module RU name is always in upper case EBCDIC.</p>
<p><strong>LIC module name.</strong> The name of the module which requested the LIC
log entry. If the module name is greater than 64 characters, the LIC module name is
truncated to 64 characters.</p>
<p><strong>LIC module entry point name.</strong> The name of the entry point which
requested the LIC log entry. If the entry point name is greater than 128 characters,
the LIC module entry point name is truncated to 128 characters.</p>
<p><strong>Message comparison data.</strong> The user specified text string used to
compare against the message data of the watched for message ID.</p>
<p><strong>Message file library.</strong> The name of the library containing the
message file.</p>
<p><strong>Message file name.</strong> The name of the message file that was used
to send the message.</p>
<p><strong>Message ID.</strong> The identifier of the message that occurred.</p>
<p><strong>Message key.</strong> The message reference key of the message that
occurred. This field is set to blanks if *JOBLOG is specified for the message queue
name.</p>
<p><strong>Message queue library.</strong> The name of the library where the message
queue is located. This field is set to blanks if *JOBLOG is specified for the message
queue name.</p>
<p><strong>Message queue name.</strong> The name of the message queue where the message
was sent. If *JOBLOG is passed, it means that the message id was sent to a program
message queue in the job specified in job name, job user name and job number fields</p>
<p><strong>Message replacement data.</strong> The values for substitution variables in
the message sent. Note that pointer values will not be valid when received by the exit
program.</p>
<p><strong>Message severity.</strong> The severity code, ranging from 00 through 99,
of the message.</p>
<p><strong>Message timestamp.</strong> The timestamp of when the message was sent.
The format for this field is the system time-stamp format. The Convert Date and Time
Format (QWCCVTDT) API can be used to convert a time-stamp value to character format.
Notice that when *JOBLOG is specified for the message queue name field, the time-stamp
passed might not match exactly with the time sent shown in the corresponding job log.</p>
<p><strong>Message type.</strong> The type assigned to the message when it was sent.
The possible values are:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top"><em>*COMP</em></td>
<td align="left" valign="top">Completion</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DIAG</em></td>
<td align="left" valign="top">Diagnostic</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ESCAPE</em></td>
<td align="left" valign="top">Escape</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INFO</em></td>
<td align="left" valign="top">Informational</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INQ</em></td>
<td align="left" valign="top">Inquiry</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOTIFY</em></td>
<td align="left" valign="top">Notify</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SCOPE</em></td>
<td align="left" valign="top">Scope</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STATUS</em></td>
<td align="left" valign="top">Status</td>
</tr>
</table>
<br>
<p><strong>Offset to comparison data.</strong> The offset to the field that
holds the comparison data.</p>
<p><strong>Offset to receiving procedure name.</strong> The offset to the field that
holds the procedure the message was sent to when the message was sent to a procedure
within an ILE program. This field is set to zero if the message was sent to an
original program model (OPM) program or when the message is sent to a nonprogram
message queue.</p>
<p><strong>Offset to replacement data.</strong> The offset to the field that holds
the replacement data.</p>
<p><strong>Offset to sending procedure name.</strong> The offset to the field that holds
the procedure sending the message when the message was sent from a procedure within an
ILE program. This field is set to zero if the message was sent from an original
program model (OPM) program.</p>
<p><strong>Offset where comparison data was found.</strong> The offset in the message
replacement data, the sending program name or the receiving program name, where the
message comparison data was found. This field is set to zero if zero was specified
for the length of comparison data field.</p>
<p><strong>Receiving module name.</strong> The name of the module the message was
sent to when the message was sent to a procedure within an ILE program. If the message
was sent to an original program model (OPM) program, this field is set to blanks. This
field will be blank if the message is sent to a nonprogram message queue.</p>
<p><strong>Receiving procedure name.</strong> The name of the procedure the message
was sent to when the message was sent to a procedure within an ILE program. A nested
procedure name has each procedure name separated by a colon. The outermost procedure
name is identified first followed by the procedures it contains. The innermost
procedure is identified last in the string.</p>
<p><strong>Receiving program name.</strong> The name of the program the message was
sent to, or the Integrated Language Environment (ILE) program name that contains the
procedure the message was sent to. This field will be blank if the message is sent to
a nonprogram message queue.</p>
<p><strong>Replacement data CCSID.</strong> The coded character set identifier (CCSID)
that the message data is 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 there is no *CCHAR replacement data, 65535 is returned.</p>
<p>For more information about message handler and its use of CCSIDs, see <a
href="../nls/rbagsccsidmsgsup2.htm">CCSIDs: Message Support</a> in the
Globalization topic. For more information about the *CCHAR field type, see the
<a href="../cl/addmsgd.htm">Add Message Description</a> (ADDMSGD) command.</p>
<p><strong>Sending module name.</strong> The name of the module that contains the
sending message when the sender is a procedure within an ILE program.</p>
<p><strong>Sending procedure name.</strong> The name of the procedure sending the
message when the sender is a procedure within an ILE program. A nested procedure
name has each procedure name separated by a colon. The outermost procedure name is
identified first followed by the procedures it contains. The innermost procedure
is identified last in the string.</p>
<p><strong>Sending program name.</strong> The program name or ILE program name that
contains the procedure sending the message.</p>
<p><strong>Server type.</strong> The type of server that requested the LIC log entry.
Server type is blank (hex 40s) if the LIC log entry was not requested by a server.</p>
<p><strong>Task name.</strong> The name of the task which requested the LIC log entry.
Task name is blank (hex 40s) if the LIC log entry was not requested by a task.</p>
<p><strong>TDE number.</strong> The number of the task dispatching element (TDE) which
requested the LIC log entry.</p>
<p><strong>Thread ID.</strong> The thread which requested the LIC log entry.
Thread identifier is binary zeros if the LIC log entry was not requested by a thread.</p>
<br>
<h3><a NAME="Header_10"></a>Usage Notes</h3>
<ol type="1">
<li>A message might be removed by a different job before the user exit program
tries to use that message.</li>
<li>A message key for a nonprogram message queue could be reused for a new message
before the exit program used the message.</li>
</ol>
<br>
<h3>Related Information</h3>
<p>See the following for more information:</p>
<ul>
<li><a href="../cl/strwch.htm">Start Watch</a> (STRWCH) command</li>
<li><a href="qscswch.htm">Start Watch</a> (QSCSWCH) API</li>
</ul>
<img src="deltaend.gif" alt="End of change">
<br>
<hr>
Exit program introduced: V5R4&nbsp;
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"pm1.htm">Problem Management APIs</a> | <a href="aplist.htm">APIs by category</a>
</td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink