← 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_c/env_dbrename.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_c/env_dbrename.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_ENV-&gt;dbrename</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_ENV-&gt;dbrename</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/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.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;dbrename(DB_ENV *dbenv, DB_TXN *txnid, const char *file,
27
 
    const char *database, const char *newname, u_int32_t flags);
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>The DB_ENV-&gt;dbrename method renames the database specified by the
31
 
<b>file</b> and <b>database</b> arguments to <b>newname</b>.  If no
32
 
<b>database</b> is specified, the underlying file represented by
33
 
<b>file</b> is renamed, incidentally renaming all databases that it
34
 
contained.
35
 
<p>Applications should not rename databases that are currently in use.  If
36
 
an underlying file is being renamed and logging is currently enabled in
37
 
the database environment, no database in the file may be open when the
38
 
DB_ENV-&gt;dbrename method is called.  In particular, some architectures do
39
 
not permit renaming files with open handles.  On these architectures,
40
 
attempts to rename databases that are currently in use by any thread of
41
 
control in the system will fail.
42
 
<p>If the operation is to be transaction-protected, the <b>txnid</b>
43
 
parameter is a transaction handle returned from <a href="../api_c/txn_begin.html">DB_ENV-&gt;txn_begin</a>;
44
 
otherwise, NULL.
45
 
<p>The <b>flags</b> value must be set to 0 or
46
 
the following value:
47
 
<p><dl compact>
48
 
<p><dt><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a><dd>Enclose the DB_ENV-&gt;dbrename call within a transaction.  If the call succeeds,
49
 
changes made by the operation will be recoverable.  If the call fails,
50
 
the operation will have made no changes.
51
 
</dl>
52
 
<p>The DB_ENV-&gt;dbrename method returns a non-zero error value on failure and 0 on success.
53
 
<h1>Environment Variables</h1>
54
 
<p><dl compact>
55
 
<p><dt>DB_HOME<dd>The 
56
 
environment variable <b>DB_HOME</b> may be used as the path of the
57
 
database environment home.
58
 
<p>DB_ENV-&gt;dbrename is affected by any database directory specified using the
59
 
<a href="../api_c/env_set_data_dir.html">DB_ENV-&gt;set_data_dir</a> method, or by setting the "set_data_dir" string
60
 
in the environment's <b>DB_CONFIG</b> file.
61
 
</dl>
62
 
<h1>Errors</h1>
63
 
<p>The DB_ENV-&gt;dbrename method may fail and return a non-zero error for the following conditions:
64
 
<p><dl compact>
65
 
<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock.
66
 
</dl>
67
 
<p><dl compact>
68
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
69
 
<p>A database in the file is currently open.
70
 
<p>Called before <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> was called.
71
 
</dl>
72
 
<p>The DB_ENV-&gt;dbrename method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
73
 
If a catastrophic error has occurred, the DB_ENV-&gt;dbrename method may fail and
74
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
75
 
in which case all subsequent Berkeley DB calls will fail in the same way.
76
 
<h1>Class</h1>
77
 
<a href="../api_c/env_class.html">DB_ENV</a>
78
 
<h1>See Also</h1>
79
 
<a href="../api_c/env_list.html">Database Environments and Related Methods</a>
80
 
</tt>
81
 
<table width="100%"><tr><td><br></td><td align=right>
82
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
83
 
</td></tr></table>
84
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
85
 
</body>
86
 
</html>