libdb/docs/api_reference/C/dbget_partition_dirs.html

158 lines
5.8 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?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-&gt;get_partition_dirs()</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="db.html" title="Chapter 2.  The DB Handle" />
<link rel="prev" href="dbget_partition_callback.html" title="DB-&gt;get_partition_callback()" />
<link rel="next" href="dbget_partition_keys.html" title="DB-&gt;get_partition_keys()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB-&gt;get_partition_dirs()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_partition_callback.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. 
The DB Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbget_partition_keys.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="dbget_partition_dirs"></a>DB-&gt;get_partition_dirs()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB-&gt;get_partition_dirs(DB *db, const char ***dirsp); </pre>
<p>
Determine which directorise the database partitions files will be created in or were found in.
</p>
<p>
The <code class="methodname">DB-&gt;get_partition_dirs()</code> method may be called at any time.
</p>
<p>
The <code class="methodname">DB-&gt;get_partition_dirs()</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="id3859393"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3859382"></a>dirsp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>dirsp</strong></span> will be set to the array of directories
specified in the call to <a class="xref" href="dbset_partition_dirs.html" title="DB-&gt;set_partition_dirs()">DB-&gt;set_partition_dirs()</a>
method on this handle or to the directoreies that the database partitions were found in
after <a class="xref" href="dbopen.html" title="DB-&gt;open()">DB-&gt;open()</a> has been called.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3859176"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB-&gt;get_partition_dirs()</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="id3859469"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
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="id3859451"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2.  The DB Handle">DB</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3859229"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database 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="dbget_partition_callback.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbget_partition_keys.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB-&gt;get_partition_callback() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB-&gt;get_partition_keys()</td>
</tr>
</table>
</div>
</body>
</html>