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: DB_TXN->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>DB_TXN->discard</b> 14</td> 15<td align=right> 16<a href="../api_c/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.h> 23<p> 24int 25DB_TXN->discard(DB_TXN *tid, u_int32_t flags); 26</pre></b> 27<hr size=1 noshade> 28<b>Description: DB_TXN->discard</b> 29<p>The DB_TXN->discard method frees up all the per-process resources 30associated with the specified <a href="../api_c/txn_class.html">DB_TXN</a> handle, neither committing 31nor aborting the transaction. This call may be used only after calls 32to <a href="../api_c/txn_recover.html">DB_ENV->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_c/txn_recover.html">DB_ENV->txn_recover</a> that are not handled by 35the current global transaction manager should be discarded using 36DB_TXN->discard.</p> 37<p>The DB_TXN->discard method 38returns a non-zero error value on failure 39and 0 on success. 40</p> 41<p>After DB_TXN->discard has been called, regardless of its return, the 42<a href="../api_c/txn_class.html">DB_TXN</a> handle may not be accessed again.</p> 43<b>Parameters</b> <br> 44 <b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul> 45<br> 46<br><b>Errors</b> 47<p>The DB_TXN->discard method 48may fail and return one of the following non-zero errors:</p> 49<br> 50<b>EINVAL</b><ul compact><li>If the transaction handle does not refer to a transaction that was 51recovered into a prepared but not yet completed state; or if an 52invalid flag value or parameter was specified.</ul> 53<br> 54<hr size=1 noshade> 55<br><b>Class</b> 56<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/txn_class.html">DB_TXN</a> 57<br><b>See Also</b> 58<a href="../api_c/txn_list.html">Transaction Subsystem and Related Methods</a> 59</tt> 60<table width="100%"><tr><td><br></td><td align=right> 61<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> 62</td></tr></table> 63<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 64</body> 65</html> 66
