env_fileid_reset.html [plain text]
<!--$Id: env_fileid_reset.so,v 1.3 2005/12/13 16:48:01 bostic Exp $-->
<!--Copyright (c) 1997,2007 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::fileid_reset</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>
<h3>DbEnv::fileid_reset</h3>
</td>
<td align=right>
<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></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbEnv::fileid_reset(const char *file, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::fileid_reset</h3>
<p>The DbEnv::fileid_reset method allows database files to be copied, and
then the copy used in the same database environment as the original.</p>
<p>All databases contain an ID string used to identify the database in the
database environment cache. If a physical database file is copied, and
used in the same environment as another file with the same ID strings,
corruption can occur. The DbEnv::fileid_reset method creates new ID
strings for all of the databases in the physical file.</p>
<p>The DbEnv::fileid_reset method modifies the physical file, in-place.
Applications should not reset IDs in files that are currently in use.</p>
<p>The DbEnv::fileid_reset method may be called at any time during the life of the
application.</p>
<p>The DbEnv::fileid_reset method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>file</b><dd>The name of the physical file in which new file IDs are to be created.
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt>DB_ENCRYPT<dd>The file contains encrypted databases.
</dl>
</dl>
<h3>Errors</h3>
<p>The DbEnv::fileid_reset method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/env_class.html">DbEnv</a>
<h3>See Also</h3>
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font>
</body>
</html>