| Current Path : /proc/2/cwd/usr/share/doc/db4-devel-4.7.25/api_c/ |
| Current File : //proc/2/cwd/usr/share/doc/db4-devel-4.7.25/api_c/db_truncate.html |
<!--$Id: db_truncate.so,v 1.29 2006/09/13 14:30:52 mjc Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB->truncate</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>DB->truncate</b>
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>
#include <db.h>
<p>
int
DB->truncate(DB *db,
DB_TXN *txnid, u_int32_t *countp, u_int32_t flags);
</pre></b>
<hr size=1 noshade>
<b>Description: DB->truncate</b>
<p>The DB->truncate method empties the database, discarding all records
it contains. The number of records discarded from the database is
returned in <b>countp</b>.</p>
<p>When called on a database configured with secondary indices using the
<a href="../../db4-devel-4.7.25/api_c/db_associate.html">DB->associate</a> method, the DB->truncate method truncates the primary
database and all secondary indices. A count of the records discarded
from the primary database is returned.</p>
<p>It is an error to call the DB->truncate method on a database with open
cursors.</p>
<p>The DB->truncate method
returns a non-zero error value on failure
and 0 on success.
</p>
<b>Parameters</b> <br>
<b>countp</b><ul compact><li>The <b>countp</b> parameter references memory into which
the number of records discarded from the database is copied.</ul>
<b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul>
<b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
<b>txnid</b> parameter is a transaction handle returned from
<a href="../../db4-devel-4.7.25/api_c/txn_begin.html">DB_ENV->txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the
<b>txnid</b> parameter is a handle returned from
<a href="../../db4-devel-4.7.25/api_c/env_cdsgroup_begin.html">DB_ENV->cdsgroup_begin</a>; otherwise NULL.
If no transaction handle is
specified, but the
operation occurs in a transactional
database,
the operation will be implicitly transaction protected.
</ul>
<br>
<br><b>Errors</b>
<p>The DB->truncate method
may fail and return one of the following non-zero errors:</p>
<br>
<b>DB_LOCK_DEADLOCK</b><ul compact><li>A transactional database environment operation was selected to resolve
a deadlock.</ul>
<b>DB_LOCK_NOTGRANTED</b><ul compact><li>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable
to grant a lock in the allowed time.</ul>
<br>
<br>
<b>EINVAL</b><ul compact><li>If there are open cursors in the database; or if an
invalid flag value or parameter was specified.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../../db4-devel-4.7.25/api_c/db_class.html">DB</a>
<br><b>See Also</b>
<a href="../../db4-devel-4.7.25/api_c/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>
Copyright 2K16 - 2K18 Indonesian Hacker Rulez
;?>)