• 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>Db::get_partition_dirs()</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="db.html" title="Chapter 2.  The Db Handle" />
11    <link rel="prev" href="dbget_partition_callback.html" title="Db::get_partition_callback()" />
12    <link rel="next" href="dbget_partition_keys.html" title="Db::get_partition_keys()" />
13  </head>
14  <body>
15    <div class="navheader">
16      <table width="100%" summary="Navigation header">
17        <tr>
18          <th colspan="3" align="center">Db::get_partition_dirs()</th>
19        </tr>
20        <tr>
21          <td width="20%" align="left"><a accesskey="p" href="dbget_partition_callback.html">Prev</a> </td>
22          <th width="60%" align="center">Chapter 2. 
23                The Db Handle
24        </th>
25          <td width="20%" align="right"> <a accesskey="n" href="dbget_partition_keys.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="dbget_partition_dirs"></a>Db::get_partition_dirs()</h2>
35          </div>
36        </div>
37      </div>
38      <pre class="programlisting">#include &lt;db_cxx.h&gt;
39
40int
41Db::get_partition_dirs(const char ***dirsp); </pre>
42      <p>
43    	Determine which directorise the database partitions files will be created in or were found in.
44    </p>
45      <p>
46             The <code class="methodname">Db::get_partition_dirs()</code> method may be called at any time.
47    </p>
48      <p>
49         The <code class="methodname">Db::get_partition_dirs()</code> <span>
50            
51            <span>
52                method either returns a non-zero error value or throws an
53                exception that encapsulates a non-zero error value on
54                failure, and returns 0 on success.
55            </span>
56        </span>
57    </p>
58      <div class="sect2" lang="en" xml:lang="en">
59        <div class="titlepage">
60          <div>
61            <div>
62              <h3 class="title"><a id="id1636845"></a>Parameters</h3>
63            </div>
64          </div>
65        </div>
66        <div class="sect3" lang="en" xml:lang="en">
67          <div class="titlepage">
68            <div>
69              <div>
70                <h4 class="title"><a id="id1637201"></a>dirsp</h4>
71              </div>
72            </div>
73          </div>
74          <p>
75                        The <span class="bold"><strong>dirsp</strong></span> will be set to the array of directories 
76                        specified in the call to <a class="xref" href="dbset_partition_dirs.html" title="Db::set_partition_dirs()">Db::set_partition_dirs()</a>
77                        method on this handle or to the directoreies that the database partitions were found in
78                        after <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> has been called.
79                    </p>
80        </div>
81      </div>
82      <div class="sect2" lang="en" xml:lang="en">
83        <div class="titlepage">
84          <div>
85            <div>
86              <h3 class="title"><a id="id1636846"></a>Errors</h3>
87            </div>
88          </div>
89        </div>
90        <p>
91                         The <code class="methodname">Db::get_partition_dirs()</code> <span>
92            
93            <span>
94                method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 
95                exception, encapsulating one of the following non-zero errors, or return one
96                of the following non-zero errors:
97            </span>
98        </span>
99                    </p>
100        <div class="sect3" lang="en" xml:lang="en">
101          <div class="titlepage">
102            <div>
103              <div>
104                <h4 class="title"><a id="id1637283"></a>EINVAL</h4>
105              </div>
106            </div>
107          </div>
108          <p>
109                An invalid flag value or parameter was specified.
110            </p>
111        </div>
112      </div>
113      <div class="sect2" lang="en" xml:lang="en">
114        <div class="titlepage">
115          <div>
116            <div>
117              <h3 class="title"><a id="id1636240"></a>Class</h3>
118            </div>
119          </div>
120        </div>
121        <p>
122                 <a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>  
123            </p>
124      </div>
125      <div class="sect2" lang="en" xml:lang="en">
126        <div class="titlepage">
127          <div>
128            <div>
129              <h3 class="title"><a id="id1637245"></a>See Also</h3>
130            </div>
131          </div>
132        </div>
133        <p>
134                     <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a> 
135                </p>
136      </div>
137    </div>
138    <div class="navfooter">
139      <hr />
140      <table width="100%" summary="Navigation footer">
141        <tr>
142          <td width="40%" align="left"><a accesskey="p" href="dbget_partition_callback.html">Prev</a> </td>
143          <td width="20%" align="center">
144            <a accesskey="u" href="db.html">Up</a>
145          </td>
146          <td width="40%" align="right"> <a accesskey="n" href="dbget_partition_keys.html">Next</a></td>
147        </tr>
148        <tr>
149          <td width="40%" align="left" valign="top">Db::get_partition_callback() </td>
150          <td width="20%" align="center">
151            <a accesskey="h" href="index.html">Home</a>
152          </td>
153          <td width="40%" align="right" valign="top"> Db::get_partition_keys()</td>
154        </tr>
155      </table>
156    </div>
157  </body>
158</html>
159