ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QZMFATCM.htm

142 lines
4.8 KiB
HTML
Raw Normal View History

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>Track Mail Message Changes Exit Program</title>
<!-- Begin Header Records ========================================== -->
<!-- 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited October 2001 -->
<!--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 language="Javascript" src ="../rzahg/synch.js" type="text/javascript"></script>
<h2>Track Mail Message Changes Exit Program</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%">Mail message identifier</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(32)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="LEFT" valign="TOP">Exit point name</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="LEFT" valign="TOP">Qualified exit point program name</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="LEFT" valign="TOP">Format name</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="LEFT" valign="TOP">Return code</td>
<td align="LEFT" valign="TOP">Output</td>
<td align="LEFT" valign="TOP">Binary(4)</td>
</tr>
</table>
<pre>
Exit Point Name: QIBM_QZMFMSF_TRK_CHG
</pre>
</div>
<p>The exit point name and the name of an exit point program (which resulted in changes to a message) are passed to the Track Mail Message Changes exit program. The exit program configured for this exit is allowed to read all of the parts of a message to track the message. The exit point, however, cannot affect the processing of the message. The return codes are provided for tracking purposes and do not affect the processing of the message.</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>Mail message identifier</strong></dt>
<dd>INPUT; CHAR(32)
<p>The variable containing the mail message identifier that the Track Mail Message Changes exit program is passing information for. The mail message identifier is composed of characters A through Z and 0 through 9 only.</p></dd>
<dt><strong>Exit point name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the user exit point that was being processed when the changes to the message were made.</p></dd>
<dt><strong>Qualified exit point program name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user qualified name of the program that was called that resulted in changes being made to the message.</p></dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The variable containing the format name of the parameter list in which the Track Mail Message Changes exit program is passing information. This field must be set to TCMM0100.</p></dd>
<dt><strong>Return code</strong></dt>
<dd>OUTPUT; BINARY(4)<br><br>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Everything was OK.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Data was not valid.</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Severe error encountered.</td>
</tr>
</table>
<p><strong>Note:</strong> This return code is stored for tracking purposes and does not affect the processing of the message.</p></dd>
</dl>
<hr>
Exit Program Introduced: V3R1
<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="off1a.htm">Office APIs</a> | <a href=
"aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>