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

199 lines
6.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 Commitment Resource (QTNRMVCR) 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. -->
<!-- JC1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Oct 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 Commitment Resource (QTNRMVCR) 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%">Resource handle</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</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;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove Commitment Resource (QTNRMVCR) API removes an API commitment
resource that was added to a commitment definition using the Add Commitment
Resource (QTNADDCR) API. For more information about adding resources to a
commitment definition, see <a href="QTNADDCR.htm">Add Commitment Resource</a>
(QTNADDCR) API.</p>
<p>Once a commitment resource is removed, the resource handle that refers to it
is no longer valid. You cannot end commitment control for a commitment
definition until all API commitment resources have been removed.</p>
<p>If an End Job (ENDJOB) command is entered or you sign off the job, the
system automatically ends commitment control for all commitment definitions for
the job. Likewise, the system will automatically end an activation-group-level
commitment definition for a nondefault activation group that is ending. Any API
commitment resources that have not yet been removed from any commitment
definition being automatically ended by the system will be implicitly removed
by the system during the end job or the activation group end processing. Prior
to the system implicitly removing the API commitment resources and
automatically ending a commitment definition, an implicit commitment control
operation is performed by the system if pending changes exist for the
commitment definition, with the appropriate exit program calls made for any API
commitment resources. An implicit commit is performed by the system if the
activation group is ending normally. An implicit rollback is performed by the
system if the activation group is ending abnormally or the job is ending. For
more information about the exit program and information that is passed to it,
see <a href="QTNEXIT.htm">Commitment Control Exit Program</a>.</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>Resource handle</strong></dt>
<dd>INPUT; BINARY(4)
<p>The resource handle returned by the QTNADDCR API when the API commitment
resource was added to the commitment definition.</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>Restrictions</h3>
<p>You are prevented from removing a commitment resource using this API
when:</p>
<ul>
<li>The resource handle is not valid.</li>
<li>Commitment control is not active for the program making the request to
remove the commitment resource.</li>
<li>A commitment control operation is currently in progress for the commitment
definition that is to have the commitment resource removed from the commitment
definition.</li>
</ul>
<p>In all other instances, the API commitment resource is removed from the
commitment definition.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF8362 E</td>
<td valign="top">Request for commit resource is not valid; reason code
&amp;1.</td>
</tr>
<tr>
<td valign="top">CPF8367 E</td>
<td valign="top">Cannot perform commitment control operation.</td>
</tr>
<tr>
<td 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>
</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=
"jc1.htm">Journal and Commit APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>