File: env_fileid_reset.html

package info (click to toggle)
db4.5 4.5.20-13
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 44,072 kB
  • ctags: 26,844
  • sloc: ansic: 133,163; tcl: 49,747; java: 28,016; perl: 13,204; sh: 12,109; cpp: 9,649; makefile: 1,931; awk: 1,316; cs: 457; xml: 113; php: 22; asm: 14
file content (76 lines) | stat: -rw-r--r-- 3,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!--$Id: env_fileid_reset.so,v 1.3 2005/12/13 16:48:01 bostic Exp $-->
<!--Copyright 1997-2006 by Oracle Corporation-->
<!--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 &lt;db_cxx.h&gt;
<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-2006 Oracle Corporation - All rights reserved.</font>
</body>
</html>