<!--$Id: env_set_tmp_dir.so,v 10.26 2004/09/28 15:04:20 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->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> <h3>DB_ENV->set_tmp_dir</h3> </td> <td align=right> <a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a> <a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a></td> </tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db.h> <p> int DB_ENV->set_tmp_dir(DB_ENV *dbenv, const char *dir); <p> int DB_ENV->get_tmp_dir(DB_ENV *dbenv, const char **dirp); </pre></h3> <hr size=1 noshade> <h3>Description: DB_ENV->set_tmp_dir</h3> <a name="2"><!--meow--></a> <p>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.</p> <p>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.</p> <ol> <p><li>The value of the environment variable <b>TMPDIR</b>. <li>The value of the environment variable <b>TEMP</b>. <li>The value of the environment variable <b>TMP</b>. <li>The value of the environment variable <b>TempFolder</b>. <li>The value returned by the GetTempPath interface. <li>The directory <b>/var/tmp</b>. <li>The directory <b>/usr/tmp</b>. <li>The directory <b>/temp</b>. <li>The directory <b>/tmp</b>. <li>The directory <b>C:/temp</b>. <li>The directory <b>C:/tmp</b>. </ol> <p>Note: environment variables are only checked if one of the <a href="../../db46-devel-4.6.21/api_c/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> or <a href="../../db46-devel-4.6.21/api_c/env_open.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a> flags were specified.</p> <p>Note: the GetTempPath interface is only checked on Win/32 platforms.</p> <p>The database environment's temporary file directory may also be configured using the environment's <b>DB_CONFIG</b> 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 <b>DB_CONFIG</b> file is read when the database environment is opened, it will silently overrule configuration done before that time.</p> <p>The DB_ENV->set_tmp_dir method configures operations performed using the specified <a href="../../db46-devel-4.6.21/api_c/env_class.html">DB_ENV</a> handle, not all operations performed on the underlying database environment.</p> <p>The DB_ENV->set_tmp_dir method may not be called after the <a href="../../db46-devel-4.6.21/api_c/env_open.html">DB_ENV->open</a> method is called. If the database environment already exists when <a href="../../db46-devel-4.6.21/api_c/env_open.html">DB_ENV->open</a> is called, the information specified to DB_ENV->set_tmp_dir must be consistent with the existing environment or corruption can occur.</p> <p>The DB_ENV->set_tmp_dir method returns a non-zero error value on failure and 0 on success. </p> <h3>Parameters</h3> <dl compact> <dt><b>dir</b><dd>The <b>dir</b> parameter is the directory to be used to store temporary files. <p>When using a Unicode build on Windows (the default), the <b>dir</b> argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.</p> </dl> <h3>Errors</h3> <p>The DB_ENV->set_tmp_dir method may fail and return one of the following non-zero errors:</p> <dl compact> <dt>EINVAL<dd>If the method was called after <a href="../../db46-devel-4.6.21/api_c/env_open.html">DB_ENV->open</a> was called; or if an invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Description: DB_ENV->get_tmp_dir</h3> <p>The DB_ENV->get_tmp_dir method returns the database environment temporary file directory.</p> <p>The DB_ENV->get_tmp_dir method may be called at any time during the life of the application.</p> <p>The DB_ENV->get_tmp_dir method returns a non-zero error value on failure and 0 on success. </p> <h3>Parameters</h3> <dl compact> <dt><b>dirp</b><dd>The DB_ENV->get_tmp_dir method returns a reference to the database environment temporary file directory in <b>dirp</b>. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db46-devel-4.6.21/api_c/env_class.html">DB_ENV</a> <h3>See Also</h3> <a href="../../db46-devel-4.6.21/api_c/env_list.html">Database Environments and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a><a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font> </body> </html>