docs/api_reference/CXX/dbget_partition_callback.html

   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_callback()</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_open_flags.html" title="Db::get_open_flags()" />
  12     <link rel="next" href="dbget_partition_dirs.html" title="Db::get_partition_dirs()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">Db::get_partition_callback()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="dbget_open_flags.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 2.
  26                 The Db Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="dbget_partition_dirs.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="dbget_partition_callback"></a>Db::get_partition_callback()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 Db::get_partition_callback(u_int32_t *partsp,
  45         u_int32_t (**callback_fcn) (DB *dbp, DBT *key);</pre>
  46       <p>
  47         The <code class="methodname">Db::get_partition_callback()</code> method returns the partitioning information as
  48         set by the <a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a> method.
  49     </p>
  50       <p>
  51          The <code class="methodname">Db::get_partition_callback()</code> method may be called at any time during the life
  52          of the application.
  53     </p>
  54       <p>
  55          The <code class="methodname">Db::get_partition_callback()</code> <span>
  56
  57             <span>
  58                 method either returns a non-zero error value or throws an
  59                 exception that encapsulates a non-zero error value on
  60                 failure, and returns 0 on success.
  61             </span>
  62         </span>
  63     </p>
  64       <div class="sect2" lang="en" xml:lang="en">
  65         <div class="titlepage">
  66           <div>
  67             <div>
  68               <h3 class="title"><a id="idm4398768"></a>Parameters</h3>
  69             </div>
  70           </div>
  71         </div>
  72         <div class="sect3" lang="en" xml:lang="en">
  73           <div class="titlepage">
  74             <div>
  75               <div>
  76                 <h4 class="title"><a id="idm4785288"></a>partsp</h4>
  77               </div>
  78             </div>
  79           </div>
  80           <p>
  81                           The
  82                           <code class="methodname">Db::get_partition_callback()</code>
  83                           method returns number of partitions in the
  84                           <span class="bold"><strong>partsp</strong></span>
  85                           parameter.
  86                      </p>
  87         </div>
  88         <div class="sect3" lang="en" xml:lang="en">
  89           <div class="titlepage">
  90             <div>
  91               <div>
  92                 <h4 class="title"><a id="idm5777872"></a>callback_fcn</h4>
  93               </div>
  94             </div>
  95           </div>
  96           <p>
  97                          The <span class="bold"><strong>callback_fcn</strong></span> parameter will be set to the partitioning function.
  98              </p>
  99         </div>
 100       </div>
 101       <div class="sect2" lang="en" xml:lang="en">
 102         <div class="titlepage">
 103           <div>
 104             <div>
 105               <h3 class="title"><a id="idm1992104"></a>Class</h3>
 106             </div>
 107           </div>
 108         </div>
 109         <p>
 110                 <a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>
 111             </p>
 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="idm821912"></a>See Also</h3>
 118             </div>
 119           </div>
 120         </div>
 121         <p>
 122                         <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
 123                         <a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a>
 124                 </p>
 125       </div>
 126     </div>
 127     <div class="navfooter">
 128       <hr />
 129       <table width="100%" summary="Navigation footer">
 130         <tr>
 131           <td width="40%" align="left"><a accesskey="p" href="dbget_open_flags.html">Prev</a> </td>
 132           <td width="20%" align="center">
 133             <a accesskey="u" href="db.html">Up</a>
 134           </td>
 135           <td width="40%" align="right"> <a accesskey="n" href="dbget_partition_dirs.html">Next</a></td>
 136         </tr>
 137         <tr>
 138           <td width="40%" align="left" valign="top">Db::get_open_flags() </td>
 139           <td width="20%" align="center">
 140             <a accesskey="h" href="index.html">Home</a>
 141           </td>
 142           <td width="40%" align="right" valign="top"> Db::get_partition_dirs()</td>
 143         </tr>
 144       </table>
 145     </div>
 146   </body>
 147 </html>