• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src/router/db-4.8.30/docs/api_reference/CXX/
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4  <head>
5    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6    <title>DbEnv::get_home()</title>
7    <link rel="stylesheet" href="apiReference.css" type="text/css" />
8    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
9    <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
10    <link rel="up" href="env.html" title="Chapter 5.  The DbEnv Handle" />
11    <link rel="prev" href="envget_flags.html" title="DbEnv::get_flags()" />
12    <link rel="next" href="envget_intermediate_dir_mode.html" title="DbEnv::get_intermediate_dir_mode()" />
13  </head>
14  <body>
15    <div class="navheader">
16      <table width="100%" summary="Navigation header">
17        <tr>
18          <th colspan="3" align="center">DbEnv::get_home()</th>
19        </tr>
20        <tr>
21          <td width="20%" align="left"><a accesskey="p" href="envget_flags.html">Prev</a> </td>
22          <th width="60%" align="center">Chapter 5. 
23                The DbEnv Handle
24        </th>
25          <td width="20%" align="right"> <a accesskey="n" href="envget_intermediate_dir_mode.html">Next</a></td>
26        </tr>
27      </table>
28      <hr />
29    </div>
30    <div class="sect1" lang="en" xml:lang="en">
31      <div class="titlepage">
32        <div>
33          <div>
34            <h2 class="title" style="clear: both"><a id="envget_home"></a>DbEnv::get_home()</h2>
35          </div>
36        </div>
37      </div>
38      <pre class="programlisting">#include &lt;db_cxx.h&gt;
39
40int
41DbEnv::get_home(const char **homep); </pre>
42      <p>
43         The <code class="methodname">DbEnv::get_home()</code> method returns the database environment home
44         directory. This directory is normally identified when the
45         <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>
46         method is called.
47    </p>
48      <p>
49         The <code class="methodname">DbEnv::get_home()</code> method may be called at any time during the
50         life of the application.
51    </p>
52      <p>
53         The <code class="methodname">DbEnv::get_home()</code> <span>
54            
55            <span>
56                method either returns a non-zero error value or throws an
57                exception that encapsulates a non-zero error value on
58                failure, and returns 0 on success.
59            </span>
60        </span>
61    </p>
62      <div class="sect2" lang="en" xml:lang="en">
63        <div class="titlepage">
64          <div>
65            <div>
66              <h3 class="title"><a id="id1665601"></a>Class</h3>
67            </div>
68          </div>
69        </div>
70        <p>
71                <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>  
72            </p>
73      </div>
74      <div class="sect2" lang="en" xml:lang="en">
75        <div class="titlepage">
76          <div>
77            <div>
78              <h3 class="title"><a id="id1665794"></a>See Also</h3>
79            </div>
80          </div>
81        </div>
82        <p>
83                     <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a> 
84                </p>
85      </div>
86    </div>
87    <div class="navfooter">
88      <hr />
89      <table width="100%" summary="Navigation footer">
90        <tr>
91          <td width="40%" align="left"><a accesskey="p" href="envget_flags.html">Prev</a> </td>
92          <td width="20%" align="center">
93            <a accesskey="u" href="env.html">Up</a>
94          </td>
95          <td width="40%" align="right"> <a accesskey="n" href="envget_intermediate_dir_mode.html">Next</a></td>
96        </tr>
97        <tr>
98          <td width="40%" align="left" valign="top">DbEnv::get_flags() </td>
99          <td width="20%" align="center">
100            <a accesskey="h" href="index.html">Home</a>
101          </td>
102          <td width="40%" align="right" valign="top"> DbEnv::get_intermediate_dir_mode()</td>
103        </tr>
104      </table>
105    </div>
106  </body>
107</html>
108