libdb/docs/api_reference/C/envfileid_reset.html
2012-11-14 16:35:20 -05:00

194 lines
7 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB_ENV-&gt;fileid_reset()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="env.html" title="Chapter 5.  The DB_ENV Handle" />
<link rel="prev" href="envfailchk.html" title="DB_ENV-&gt;failchk()" />
<link rel="next" href="envfullversion.html" title="db_full_version" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV-&gt;fileid_reset()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envfailchk.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
The DB_ENV Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envfullversion.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="envfileid_reset"></a>DB_ENV-&gt;fileid_reset()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;fileid_reset(DB_ENV *dbenv, const char *file, u_int32_t flags); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;fileid_reset()</code> 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 <code class="methodname">DB_ENV-&gt;fileid_reset()</code> method
creates new ID strings for all of the databases in the physical file.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;fileid_reset()</code> method modifies the physical file,
in-place. Applications should not reset IDs in files that are
currently in use.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;fileid_reset()</code> method may be called at any time during
the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;fileid_reset()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59392232"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp59391000"></a>file</h4>
</div>
</div>
</div>
<p>
The name of the physical file in which new file IDs are to be created.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp59416680"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or the following value:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_ENCRYPT</code>
</p>
<p>
The file contains encrypted databases.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59417864"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;fileid_reset()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp59422760"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59420816"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp59420072"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envfailchk.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envfullversion.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;failchk() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> db_full_version</td>
</tr>
</table>
</div>
</body>
</html>