txn_abort.html   [plain text]


<!--$Id: txn_abort.html,v 1.2 2004/03/30 01:21:42 jtownsen Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_TXN-&gt;abort</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h3>DB_TXN-&gt;abort</h3>
</td>
<td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
DB_TXN-&gt;abort(DB_TXN *tid);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_TXN-&gt;abort</h3>
<p>The DB_TXN-&gt;abort method causes an abnormal termination of the transaction.
The log is played backward, and any necessary undo operations are done
through the <b>tx_recover</b> function specified to
<a href="../api_c/env_set_app_dispatch.html">DB_ENV-&gt;set_app_dispatch</a>.  Before DB_TXN-&gt;abort returns, any
locks held by the transaction will have been released.</p>
<p>In the case of nested transactions, aborting a parent transaction causes
all children (unresolved or not) of the parent transaction to be aborted.</p>
<p>All cursors opened within the transaction must be closed before the
transaction is aborted.</p>
<p>After DB_TXN-&gt;abort has been called, regardless of its return, the
<a href="../api_c/txn_class.html">DB_TXN</a> handle may not be accessed again.</p>
<p>The DB_TXN-&gt;abort method
returns a non-zero error value on failure
and 0 on success.
</p>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/txn_class.html">DB_TXN</a>
<h3>See Also</h3>
<a href="../api_c/txn_list.html">Transaction Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>