← Back to branch summary

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

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/db_truncate.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
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* 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:
libdb/docs/api_cxx/db_truncate.html
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: Db::truncate</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>Db::truncate</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
 
Db::truncate(DbTxn *txnid, u_int32_t *countp, u_int32_t flags);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The Db::truncate interface empties the database, discarding all
30
 
records it contains.
31
 
The number of records discarded from the database is returned in
32
 
<b>countp</b>.
33
 
<p>If the operation is to be transaction-protected (other than by specifying
34
 
the DB_AUTO_COMMIT flag), the <b>txnid</b> parameter is a
35
 
transaction handle returned from <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>; otherwise, NULL.
36
 
<p>The <b>flags</b> value must be set to 0 or
37
 
the following value:
38
 
<p><dl compact>
39
 
<p><dt><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a><dd>Enclose the Db::truncate call within a transaction.  If the call succeeds,
40
 
changes made by the operation will be recoverable.  If the call fails,
41
 
the operation will have made no changes.
42
 
</dl>
43
 
<p>The Db::truncate method either returns a non-zero error value or throws an exception that
44
 
encapsulates a non-zero error value on failure, and returns 0 on success.
45
 
<h1>Errors</h1>
46
 
<p>The Db::truncate method may fail and throw an exception or return a non-zero error for the following conditions:
47
 
<p>The Db::truncate 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.
48
 
If a catastrophic error has occurred, the Db::truncate method may fail and
49
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
50
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
51
 
in which case all subsequent Berkeley DB calls will fail in the same way.
52
 
<h1>Class</h1>
53
 
<a href="../api_cxx/db_class.html">Db</a>
54
 
<h1>See Also</h1>
55
 
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
56
 
</tt>
57
 
<table width="100%"><tr><td><br></td><td align=right>
58
 
<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>
59
 
</td></tr></table>
60
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
61
 
</body>
62
 
</html>