Files
yasuhirokimura-db18/docs/api_reference/CXX/dbget_partition_callback.html
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

167 lines
5.7 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?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::get_partition_callback()</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_open_flags.html" title="Db::get_open_flags()" />
<link rel="next" href="dbget_partition_dirs.html" title="Db::get_partition_dirs()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 18.1.40</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">
<span xmlns="http://www.w3.org/1999/xhtml">Db::get_partition_callback()</span>
</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_open_flags.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_dirs.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_callback"></a>
<span>Db::get_partition_callback()</span>
</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
Db::get_partition_callback(u_int32_t *partsp,
u_int32_t (**callback_fcn) (DB *dbp, DBT *key);</pre>
<p>
The <code class="methodname">Db::get_partition_callback()</code> method
returns the database partitioning callback as set by the
<a class="xref" href="dbset_partition.html" title="Db::set_partition()">
<span>Db::set_partition()</span>
</a>
method.
</p>
<p>
The <code class="methodname">Db::get_partition_callback()</code> method
may be called at any time during the life of the application.
</p>
<p>
The <code class="methodname">Db::get_partition_callback()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139755633131936"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm139755633127040"></a>partsp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>partsp</strong></span>
parameter returns the number of partitions used by the
database.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm139755633528960"></a>callback_fcn</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>callback_fcn</strong></span>
parameter returns the partitioning callback.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139755632070672"></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="idm139755633144112"></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>,
<a class="xref" href="dbset_partition.html" title="Db::set_partition()">
<span>Db::set_partition()</span>
</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_open_flags.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_dirs.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span>Db::get_open_flags()</span>
 </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> 
<span>Db::get_partition_dirs()</span>
</td>
</tr>
</table>
</div>
</body>
</html>