1<!--$Id: txn_discard.so,v 10.16 2004/08/13 03:39:03 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DbTxn::discard</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DbTxn::discard</b> 14</td> 15<td align=right> 16<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a> 17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db_cxx.h> 23<p> 24int 25DbTxn::discard(u_int32_t flags); 26</pre></b> 27<hr size=1 noshade> 28<b>Description: DbTxn::discard</b> 29<p>The DbTxn::discard method frees up all the per-process resources 30associated with the specified <a href="/api_cxx/txn_class.html">DbTxn</a> handle, neither committing 31nor aborting the transaction. This call may be used only after calls 32to <a href="/api_cxx/txn_recover.html">DbEnv::txn_recover</a> when there are multiple global transaction 33managers recovering transactions in a single Berkeley DB environment. Any 34transactions returned by <a href="/api_cxx/txn_recover.html">DbEnv::txn_recover</a> that are not handled by 35the current global transaction manager should be discarded using 36DbTxn::discard.</p> 37<p>The DbTxn::discard method 38either returns a non-zero error value 39or throws an exception that encapsulates a non-zero error value on 40failure, and returns 0 on success. 41</p> 42<p>After DbTxn::discard has been called, regardless of its return, the 43<a href="/api_cxx/txn_class.html">DbTxn</a> handle may not be accessed again.</p> 44<b>Parameters</b> <br> 45 <b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul> 46<br> 47<br><b>Errors</b> 48<p>The DbTxn::discard method 49may fail and throw 50<a href="/api_cxx/except_class.html">DbException</a>, 51encapsulating one of the following non-zero errors, or return one of 52the following non-zero errors:</p> 53<br> 54<b>EINVAL</b><ul compact><li>If the transaction handle does not refer to a transaction that was 55recovered into a prepared but not yet completed state; or if an 56invalid flag value or parameter was specified.</ul> 57<br> 58<hr size=1 noshade> 59<br><b>Class</b> 60<a href="/api_cxx/env_class.html">DbEnv</a>, <a href="/api_cxx/txn_class.html">DbTxn</a> 61<br><b>See Also</b> 62<a href="/api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a> 63</tt> 64<table width="100%"><tr><td><br></td><td align=right> 65<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 66</td></tr></table> 67<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 68</body> 69</html> 70
