diff options
| author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
|---|---|---|
| committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
| commit | 3ef782d3745ea8f25a3151561a3cfb882190210e (patch) | |
| tree | 86b9c2f5fde051dd0bced99b3fc9f5a3ba08db69 /docs/api_reference/CXX/envset_data_dir.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/CXX/envset_data_dir.html')
| -rw-r--r-- | docs/api_reference/CXX/envset_data_dir.html | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/docs/api_reference/CXX/envset_data_dir.html b/docs/api_reference/CXX/envset_data_dir.html new file mode 100644 index 00000000..ad78920f --- /dev/null +++ b/docs/api_reference/CXX/envset_data_dir.html @@ -0,0 +1,215 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>DbEnv::set_data_dir()</title> + <link rel="stylesheet" href="apiReference.css" type="text/css" /> + <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> + <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> + <link rel="up" href="env.html" title="Chapter 5. The DbEnv Handle" /> + <link rel="prev" href="envset_backup_config.html" title="DbEnv::set_backup_config()" /> + <link rel="next" href="envset_create_dir.html" title="DbEnv::set_create_dir()" /> + </head> + <body> + <div xmlns="" class="navheader"> + <div class="libver"> + <p>Library Version 11.2.5.3</p> + </div> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">DbEnv::set_data_dir()</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="envset_backup_config.html">Prev</a> </td> + <th width="60%" align="center">Chapter 5. + The DbEnv Handle + </th> + <td width="20%" align="right"> <a accesskey="n" href="envset_create_dir.html">Next</a></td> + </tr> + </table> + <hr /> + </div> + <div class="sect1" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h2 class="title" style="clear: both"><a id="envset_data_dir"></a>DbEnv::set_data_dir()</h2> + </div> + </div> + </div> + <pre class="programlisting">#include <db_cxx.h> + +int +DbEnv::set_data_dir(const char *dir); </pre> + <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> + <h3 class="title">Note</h3> + <p> + This interface has been deprecated. You should use + <a class="xref" href="envadd_data_dir.html" title="DbEnv::add_data_dir()">DbEnv::add_data_dir()</a> + and <a class="xref" href="envset_create_dir.html" title="DbEnv::set_create_dir()">DbEnv::set_create_dir()</a> + instead. + </p> + </div> + <p> + Set the path of a directory to be used as the location of the access + method database files. Paths specified to the + <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> function will be + searched relative to this path. Paths set using this method are + additive, and specifying more than one will result in each specified + directory being searched for database files. If any directories are + specified, database files will always be created in the first + path specified. + </p> + <p> + If no database directories are specified, database files must be named + either by absolute paths or relative to the environment home + directory. See + <a href="../../programmer_reference/env_naming.html" class="olink">Berkeley DB File Naming</a> + for more information. + </p> + <p> + The database environment's data directories may also be configured + using the environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The syntax of the entry + in that file is a single line with the string "set_data_dir", one + or more whitespace characters, and the directory name. Note that + if you use this method for your application, and you also want to + use the + <a class="xref" href="db_recover.html" title="db_recover">db_recover</a> or + <a class="xref" href="db_archive.html" title="db_archive">db_archive</a> + utilities, then you should create a <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file and set + the "set_data_dir" parameter in it. + </p> + <p> + The <code class="methodname">DbEnv::set_data_dir()</code> method + configures operations performed using the specified + <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle, not all operations + performed on the underlying database environment. + </p> + <p> + The <code class="methodname">DbEnv::set_data_dir()</code> method may not + be called after the + <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is + called. If the database environment already exists when + <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> is called, the + information specified to + <code class="methodname">DbEnv::set_data_dir()</code> must be consistent + with the existing environment or corruption can occur. + </p> + <p> + The <code class="methodname">DbEnv::set_data_dir()</code> <span> + + <span> + 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. + </span> + </span> + </p> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp1844448"></a>Parameters</h3> + </div> + </div> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp1856656"></a>dir</h4> + </div> + </div> + </div> + <p> + The <span class="bold"><strong>dir</strong></span> parameter is a + directory to be used as a location for database files. + This directory must currently exist at environment open + time. + </p> + <p> + When using a Unicode build on Windows (the default), this + argument will be interpreted as a UTF-8 string, which is + equivalent to ASCII for Latin characters. + </p> + </div> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp1819880"></a>Errors</h3> + </div> + </div> + </div> + <p> + The <code class="methodname">DbEnv::set_data_dir()</code> <span> + + <span> + method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> + exception, encapsulating one of the following non-zero errors, or return one + of the following non-zero errors: + </span> + </span> + </p> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp1866488"></a>EINVAL</h4> + </div> + </div> + </div> + <p> + If the method was called after <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> + was called; or if an invalid flag value or parameter was specified. + </p> + </div> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp1856824"></a>Class</h3> + </div> + </div> + </div> + <p> + <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> + </p> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp1837544"></a>See Also</h3> + </div> + </div> + </div> + <p> + <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a> + </p> + </div> + </div> + <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"><a accesskey="p" href="envset_backup_config.html">Prev</a> </td> + <td width="20%" align="center"> + <a accesskey="u" href="env.html">Up</a> + </td> + <td width="40%" align="right"> <a accesskey="n" href="envset_create_dir.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">DbEnv::set_backup_config() </td> + <td width="20%" align="center"> + <a accesskey="h" href="index.html">Home</a> + </td> + <td width="40%" align="right" valign="top"> DbEnv::set_create_dir()</td> + </tr> + </table> + </div> + </body> +</html> |