~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/txn_discard.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

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