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

232 lines
5.7 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>Roll Back EDRS Server (QxdaRollbackEDRS) 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. -->
<!-- File 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 March 2001 -->
<!-- This file has undergone html cleanup on 1/7/02 by JET -->
<!--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>Roll Back EDRS Server (QxdaRollbackEDRS) API</h2>
<div class="box" style="width: 80%;">
<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%">Connection 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">Additional rollback options</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">SQL communications area</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(136)</td>
</tr>
<tr>
<td align="center" valign="top">4</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: QXDAEDRS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Conditional; see <a href="#usage_notes">Usage
Notes</a><br>
<br>
</div>
<p>The Roll Back EDRS Server (QxdaRollbackEDRS) API is used to roll back
transactions on the database server.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Connection handle</strong></dt>
<dd>INPUT; BINARY(4)
<p>The handle number of the connection on which to perform the rollback
operation. The connection handle must have been generated by the
QxdaConnectEDRS API in the current job and activation group.</p>
</dd>
<dt><strong>Additional rollback options</strong></dt>
<dd>INPUT; BINARY(4)
<p>The following are valid rollback options:</p>
<table width="100%">
<tr>
<td width="5%" valign="top"><em>0</em></td>
<td width="95%" valign="top">QXDA_ROLLBACK_WORK</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">QXDA_ROLLBACK_WITH_HOLD</td>
</tr>
</table>
<br>
</dd>
<dt><strong>SQL communications area</strong></dt>
<dd>OUTPUT; CHAR(136)
<p>Returns diagnostic information. It includes the SQLCODE variable, indicating
whether an error has occurred. If SQLCODE has a value of 0 after a call to this
API, the function was successful.</p>
<p>The format of this structure is standard and is described morecompletely in
the <a href="../sqlp/rbafykickoff.htm">DB2 UDB for iSeries SQL Programming
Concepts</a> and <a href="../db2/rbafzmst02.htm">DB2 UDB for iSeries SQL
Reference</a> books.</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><a name="usage_notes">Usage Notes</a></h3>
<p>This function may be called from the initial thread of a job only.</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">CPF180C E</td>
<td width="85%" valign="top">Function &amp;1 not allowed.</td>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td 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">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 valign="top">CPFB750 E</td>
<td valign="top">Connection handle specified not valid.</td>
</tr>
<tr>
<td valign="top">CPFB751 E</td>
<td valign="top">Parameter &amp;1 passed not correct.</td>
</tr>
<tr>
<td valign="top">CPFB752 E</td>
<td valign="top">Internal error in &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPFB757 E</td>
<td valign="top">The connection is suspended.</td>
</tr>
<tr>
<td valign="top">CPFB758 E</td>
<td valign="top">The EDRS server system has been switched.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#top_Of_Page">Top</a> | <a href=
"file1.htm">Database and File APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
<br>
</body>
</html>