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_keys()</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_dirs.html" title="Db::get_partition_dirs()" /> 12 <link rel="next" href="dbget_pagesize.html" title="Db::get_pagesize()" /> 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_keys()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbget_partition_dirs.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_pagesize.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_keys"></a>Db::get_partition_keys()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41Db::get_partition_keys(u_int32_t *partsp, DBT *keysp);</pre> 42 <p> 43 The <code class="methodname">Db::get_partition_keys()</code> method returns the partitioning information as 44 set by the <a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a> method. 45 </p> 46 <p> 47 The <code class="methodname">Db::get_partition_keys()</code> method may be called at any time during the life 48 of the application. 49 </p> 50 <p> 51 The <code class="methodname">Db::get_partition_keys()</code> <span> 52 53 <span> 54 method either returns a non-zero error value or throws an 55 exception that encapsulates a non-zero error value on 56 failure, and returns 0 on success. 57 </span> 58 </span> 59 </p> 60 <div class="sect2" lang="en" xml:lang="en"> 61 <div class="titlepage"> 62 <div> 63 <div> 64 <h3 class="title"><a id="id1636234"></a>Parameters</h3> 65 </div> 66 </div> 67 </div> 68 <div class="sect3" lang="en" xml:lang="en"> 69 <div class="titlepage"> 70 <div> 71 <div> 72 <h4 class="title"><a id="id1637181"></a>partsp</h4> 73 </div> 74 </div> 75 </div> 76 <p> 77 The 78 <code class="methodname">Db::get_partition_keys()</code> 79 method returns number of partitions in the 80 <span class="bold"><strong>partsp</strong></span> 81 parameter. 82 </p> 83 </div> 84 <div class="sect3" lang="en" xml:lang="en"> 85 <div class="titlepage"> 86 <div> 87 <div> 88 <h4 class="title"><a id="id1637416"></a>keysp</h4> 89 </div> 90 </div> 91 </div> 92 <p> 93 The <span class="bold"><strong>keysp</strong></span> parameter will be set to the array of partitioning keys. 94 </p> 95 </div> 96 </div> 97 <div class="sect2" lang="en" xml:lang="en"> 98 <div class="titlepage"> 99 <div> 100 <div> 101 <h3 class="title"><a id="id1637654"></a>Class</h3> 102 </div> 103 </div> 104 </div> 105 <p> 106 <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> 107 </p> 108 </div> 109 <div class="sect2" lang="en" xml:lang="en"> 110 <div class="titlepage"> 111 <div> 112 <div> 113 <h3 class="title"><a id="id1637658"></a>See Also</h3> 114 </div> 115 </div> 116 </div> 117 <p> 118 <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>, 119 <a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a> 120 </p> 121 </div> 122 </div> 123 <div class="navfooter"> 124 <hr /> 125 <table width="100%" summary="Navigation footer"> 126 <tr> 127 <td width="40%" align="left"><a accesskey="p" href="dbget_partition_dirs.html">Prev</a> </td> 128 <td width="20%" align="center"> 129 <a accesskey="u" href="db.html">Up</a> 130 </td> 131 <td width="40%" align="right"> <a accesskey="n" href="dbget_pagesize.html">Next</a></td> 132 </tr> 133 <tr> 134 <td width="40%" align="left" valign="top">Db::get_partition_dirs() </td> 135 <td width="20%" align="center"> 136 <a accesskey="h" href="index.html">Home</a> 137 </td> 138 <td width="40%" align="right" valign="top"> Db::get_pagesize()</td> 139 </tr> 140 </table> 141 </div> 142 </body> 143</html> 144