Edit File - File Manager

Edit File: env_set_tmp_dir.html

<html>
<head>
<title>Berkeley DB: DbEnv::set_tmp_dir</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>
DbEnv::set_tmp_dir
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbEnv::set_tmp_dir(const char *dir);

int
DbEnv::get_tmp_dir(const char **dirp);
</pre>
<hr size=1 noshade>
Description: DbEnv::set_tmp_dir
<a name="2"></a>
Specify the path of a directory to be used as the location of temporary
files. The files created to back in-memory access method databases will
be created relative to this path. These temporary files can be quite
large, depending on the size of the database.
If no directories are specified, the following alternatives are checked
in the specified order. The first existing directory path is used for
all temporary files.
<ol>
<li>The value of the environment variable TMPDIR.
<li>The value of the environment variable TEMP.
<li>The value of the environment variable TMP.
<li>The value of the environment variable TempFolder.
<li>The value returned by the GetTempPath interface.
<li>The directory /var/tmp.
<li>The directory /usr/tmp.
<li>The directory /temp.
<li>The directory /tmp.
<li>The directory C:/temp.
<li>The directory C:/tmp.
</ol>
Note: environment variables are only checked if one of the
<a href="../../db4-devel-4.7.25/api_cxx/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> or <a href="../../db4-devel-4.7.25/api_cxx/env_open.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a> flags were
specified.
Note: the GetTempPath interface is only checked on Win/32 platforms.
The database environment's temporary file directory may also be configured using the
environment's <a href="../../db4-devel-4.7.25/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file. The syntax of the entry in that
file is a single line with the string "set_tmp_dir", one or more whitespace
characters, and the directory name.
Because the <a href="../../db4-devel-4.7.25/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file is read when the database environment
is opened, it will silently overrule configuration done before that
time.
The DbEnv::set_tmp_dir method configures operations performed using the specified
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
database environment.
The DbEnv::set_tmp_dir method may be called at any time during the life of the
application.
The DbEnv::set_tmp_dir 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.

Parameters 
 dir<ul compact><li>The dir parameter is the directory to be used to store temporary
files.</ul>
When using a Unicode build on Windows (the default), the dir
argument will be interpreted as a UTF-8 string, which is equivalent to
ASCII for Latin characters.
 
 Errors
The DbEnv::set_tmp_dir method
may fail and throw
<a href="../../db4-devel-4.7.25/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
 
EINVAL<ul compact><li>If the method was called after <a href="../../db4-devel-4.7.25/api_cxx/env_open.html">DbEnv::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
 
<hr size=1 noshade>
Description: DbEnv::get_tmp_dir
The DbEnv::get_tmp_dir method returns the database environment temporary file directory.
The DbEnv::get_tmp_dir method may be called at any time during the life of the
application.
The DbEnv::get_tmp_dir 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.

Parameters 
 dirp<ul compact><li>The DbEnv::get_tmp_dir method returns a reference to the
database environment temporary file directory in dirp.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager