<!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>Rollback Required (QTNRBRQD) 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>Rollback Required (QTNRBRQD) API</h2> <div class="box" style="width: 60%;"> <br> 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> Threadsafe: Yes<br> <!-- iddvc RMBR --> <br> </div> <p>The Rollback Required (QTNRBRQD) API puts the commitment definition currently active for the activation group of the program making the request into a rollback-required state. When a commitment definition is in a rollback-required state, protected resources cannot be used until a rollback operation is performed.</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 Add Commitment Resource (QTNADDCR) API when the API commitment resource was added to the current 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 putting the current commitment definition in a rollback-required state when:</p> <ul> <li>The resource handle is not valid.</li> <li>Commitment control is not active for the program making the request to put the commitment definition into a rollback required state.</li> <li>Commit or rollback processing is in progress for the current commitment definition.</li> </ul> <p>In all other instances, the current commitment definition is put in a rollback-required state.</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 &1.</td> </tr> <tr> <td valign="top">CPF8367 E</td> <td valign="top">Cannot perform commitment control operation.</td> </tr> </table> <br> <hr> API introduced: V2R3 <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>