libdb/docs/api_reference/C/envget_lk_partitions.html

163 lines
6.2 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_ENV-&gt;get_lk_partitions()</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="lock.html" title="Chapter 6.  The DB_LOCK Handle" />
<link rel="prev" href="envget_lk_max_objects.html" title="DB_ENV-&gt;get_lk_max_objects()" />
<link rel="next" href="envget_lk_priority.html" title="DB_ENV-&gt;get_lk_priority()" />
</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_ENV-&gt;get_lk_partitions()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envget_lk_max_objects.html">Prev</a> </td>
<th width="60%" align="center">Chapter 6. 
The DB_LOCK Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envget_lk_priority.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="envget_lk_partitions"></a>DB_ENV-&gt;get_lk_partitions()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;get_lk_partitions(DB_ENV *dbenv, u_int32_t *lk_partitions); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;get_lk_partitions()</code> method returns the number of
lock table partitions used in the Berkeley DB environment. You can configure this using the
<a class="xref" href="envset_lk_partitions.html" title="DB_ENV-&gt;set_lk_partitions()">DB_ENV-&gt;set_lk_partitions()</a>
method.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;get_lk_partitions()</code> method may be called at any time
during the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;get_lk_partitions()</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="id3900849"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3900852"></a>lk_partitions</h4>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;get_lk_partitions()</code> method returns the number of
partitions in <span class="bold"><strong>lk_partitions</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3900574"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;get_lk_partitions()</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="id3901091"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
The method was called on an environment which had been
opened without being configured for locking.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3901073"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>,
<a class="link" href="lock.html" title="Chapter 6.  The DB_LOCK Handle">DB_LOCK</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3900853"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>,
<a class="xref" href="envset_lk_partitions.html" title="DB_ENV-&gt;set_lk_partitions()">DB_ENV-&gt;set_lk_partitions()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envget_lk_max_objects.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="lock.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envget_lk_priority.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;get_lk_max_objects() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;get_lk_priority()</td>
</tr>
</table>
</div>
</body>
</html>