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

153 lines
5.2 KiB
HTML

<!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>Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API</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>Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API</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%">Reserved 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">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">3</td>
<td align="LEFT" valign="TOP">Error code</td>
<td align="LEFT" valign="TOP">I/O</td>
<td align="LEFT" valign="TOP">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program: QZMFASRV<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API can be used to remove an identifier for an electronic mail message that has been reserved using the Reserve Mail Message (QzmfRsvMailMsgId) API but that has not been created. If the message has been created, the Creation Sequence Complete (QzmfCrtCmpMailMsg) API must be used to release the reserved message identifier. After the Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API completes successfully, the message identifier reserved earlier is no longer available to be used in message creation.</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>Reserved mail message identifier</strong></dt>
<dd>INPUT; CHAR(32)
<p>The variable containing the unique message identifier to be removed from reserved status. After this API has completed running, the message identifier can no longer be used with the Create Mail Message (QzmfCrtMailMsg) API to pass information that defines the message. The reserved message identifier is composed of characters A through Z and 0 through 9 only.</p></dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The variable containing the format identifier of the parameter list being passed. This field must be set to RMVF0100.</p></dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p></dd>
</dl>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF82 E</td>
<td valign="top">Error occurred during running of MSF API.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF83 E</td>
<td valign="top">Parameter error on call to MSF API. Reason code &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF8B E</td>
<td valign="top">Reserved mail message identifier is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF8D E</td>
<td valign="top">Reserved mail message identifier already used.</td>
</tr>
</table>
<br>
<hr>
API 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>