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/C/envset_create_dir.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/C/envset_create_dir.html')
| -rw-r--r-- | docs/api_reference/C/envset_create_dir.html | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/docs/api_reference/C/envset_create_dir.html b/docs/api_reference/C/envset_create_dir.html new file mode 100644 index 00000000..cabc65b9 --- /dev/null +++ b/docs/api_reference/C/envset_create_dir.html @@ -0,0 +1,184 @@ +<?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>DB_ENV->set_create_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 DB_ENV Handle" /> + <link rel="prev" href="envset_data_dir.html" title="DB_ENV->set_data_dir()" /> + <link rel="next" href="envset_encrypt.html" title="DB_ENV->set_encrypt()" /> + </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">DB_ENV->set_create_dir()</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="envset_data_dir.html">Prev</a> </td> + <th width="60%" align="center">Chapter 5. + The DB_ENV Handle + </th> + <td width="20%" align="right"> <a accesskey="n" href="envset_encrypt.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_create_dir"></a>DB_ENV->set_create_dir()</h2> + </div> + </div> + </div> + <pre class="programlisting">#include <db.h> + +int +DB_ENV->set_create_dir(DB_ENV *dbenv, const char *dir); </pre> + <p> + Sets the path of a directory to be used as the location to create the access + method database files. When the + <a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> function is used to + create a file it will be created relative to this path. + </p> + <p> + If no database directories are specified, database files will be created + 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 create directory 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_create_dir", one or more whitespace characters, and the directory + name. + </p> + <p> + The <code class="methodname">DB_ENV->set_create_dir()</code> method configures operations performed + using the specified <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> + handle, not all operations performed on the underlying database environment. + </p> + <p> + The <code class="methodname">DB_ENV->set_create_dir()</code> method may be called at any time. + </p> + <p> + The <code class="methodname">DB_ENV->set_create_dir()</code> <span> + <span> + method returns a non-zero error value on failure and 0 on success. + </span> + + </span> + </p> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp59817488"></a>Parameters</h3> + </div> + </div> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp59864024"></a>dir</h4> + </div> + </div> + </div> + <p> + The <span class="bold"><strong>dir</strong></span> parameter is a directory to + be used to create database files. + This directory must be one of the directories specified via a call to + <a class="xref" href="envadd_data_dir.html" title="DB_ENV->add_data_dir()">DB_ENV->add_data_dir()</a> + </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="idp59787576"></a>Errors</h3> + </div> + </div> + </div> + <p> + The <code class="methodname">DB_ENV->set_create_dir()</code> <span> + <span> + method may fail and 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="idp59870368"></a>EINVAL</h4> + </div> + </div> + </div> + <p> + If the method was called after <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->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="idp59869288"></a>Class</h3> + </div> + </div> + </div> + <p> + <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> + </p> + </div> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp59864216"></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_data_dir.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_encrypt.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">DB_ENV->set_data_dir() </td> + <td width="20%" align="center"> + <a accesskey="h" href="index.html">Home</a> + </td> + <td width="40%" align="right" valign="top"> DB_ENV->set_encrypt()</td> + </tr> + </table> + </div> + </body> +</html> |