← 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_cxx/env_set_tmp_dir.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_cxx/env_set_tmp_dir.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: DbEnv::set_tmp_dir</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>DbEnv::set_tmp_dir</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_cxx/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_cxx.h&gt;
24
 
<p>
25
 
int
26
 
DbEnv::set_tmp_dir(const char *dir);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<a name="3"><!--meow--></a>
30
 
<p>The path of a directory to be used as the location of temporary files.
31
 
The files created to back in-memory access method databases will be
32
 
created relative to this path.  These temporary files can be quite large,
33
 
depending on the size of the database.
34
 
<p>If no directories are specified, the following alternatives are checked
35
 
in the specified order.  The first existing directory path is used for
36
 
all temporary files.
37
 
<p><ol>
38
 
<p><li>The value of the environment variable <b>TMPDIR</b>.
39
 
<li>The value of the environment variable <b>TEMP</b>.
40
 
<li>The value of the environment variable <b>TMP</b>.
41
 
<li>The value of the environment variable <b>TempFolder</b>.
42
 
<li>The value returned by the GetTempPath interface.
43
 
<li>The directory <b>/var/tmp</b>.
44
 
<li>The directory <b>/usr/tmp</b>.
45
 
<li>The directory <b>/temp</b>.
46
 
<li>The directory <b>/tmp</b>.
47
 
<li>The directory <b>C:/temp</b>.
48
 
<li>The directory <b>C:/tmp</b>.
49
 
</ol>
50
 
<p>Note: environment variables are only checked if one of the
51
 
<a href="../api_cxx/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> or <a href="../api_cxx/env_open.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a> flags were
52
 
specified.
53
 
<p>Note: the GetTempPath interface is only checked on Win/32 platforms.
54
 
<p>The DbEnv::set_tmp_dir method configures operations performed using the specified
55
 
<a href="../api_cxx/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
56
 
database environment.
57
 
<p>The DbEnv::set_tmp_dir interface may not be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a>
58
 
interface is called.
59
 
If the database environment already exists when
60
 
<a href="../api_cxx/env_open.html">DbEnv::open</a> is called, the information specified to DbEnv::set_tmp_dir
61
 
must be consistent with the existing environment or corruption can
62
 
occur.
63
 
<p>The DbEnv::set_tmp_dir method either returns a non-zero error value or throws an exception that
64
 
encapsulates a non-zero error value on failure, and returns 0 on success.
65
 
<p>The database environment's temporary file directory may also be set using the environment's
66
 
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
67
 
single line with the string "set_tmp_dir", one or more whitespace characters,
68
 
and the directory name.  Because the <b>DB_CONFIG</b> file is read when the database
69
 
environment is opened, it will silently overrule configuration done
70
 
before that time.
71
 
<h1>Errors</h1>
72
 
<p>The DbEnv::set_tmp_dir method may fail and throw an exception or return a non-zero error for the following conditions:
73
 
<p><dl compact>
74
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
75
 
<p>Called after <a href="../api_cxx/env_open.html">DbEnv::open</a> was called.
76
 
</dl>
77
 
<p>The DbEnv::set_tmp_dir method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
78
 
If a catastrophic error has occurred, the DbEnv::set_tmp_dir method may fail and
79
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
80
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
81
 
in which case all subsequent Berkeley DB calls will fail in the same way.
82
 
<h1>Class</h1>
83
 
<a href="../api_cxx/env_class.html">DbEnv</a>
84
 
<h1>See Also</h1>
85
 
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
86
 
</tt>
87
 
<table width="100%"><tr><td><br></td><td align=right>
88
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
89
 
</td></tr></table>
90
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
91
 
</body>
92
 
</html>