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_bt_minkey()</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.html" title="Db::get()" /> 12 <link rel="next" href="dbget_byteswapped.html" title="Db::get_byteswapped()" /> 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_bt_minkey()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbget.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_byteswapped.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_bt_minkey"></a>Db::get_bt_minkey()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41Db::get_bt_minkey(u_int32_t *bt_minkeyp);</pre> 42 <p> 43 The <code class="methodname">Db::get_bt_minkey()</code> method returns the minimum number of key/data 44 pairs intended to be stored on any single Btree leaf page. This value can be set using the 45 <a class="xref" href="dbset_bt_minkey.html" title="Db::set_bt_minkey()">Db::set_bt_minkey()</a> method. 46 </p> 47 <p> 48 The <code class="methodname">Db::get_bt_minkey()</code> method may be called at any time during the 49 life of the application. 50 </p> 51 <p> 52 The <code class="methodname">Db::get_bt_minkey()</code> <span> 53 54 <span> 55 method either returns a non-zero error value or throws an 56 exception that encapsulates a non-zero error value on 57 failure, and returns 0 on success. 58 </span> 59 </span> 60 </p> 61 <div class="sect2" lang="en" xml:lang="en"> 62 <div class="titlepage"> 63 <div> 64 <div> 65 <h3 class="title"><a id="id1635397"></a>Parameters</h3> 66 </div> 67 </div> 68 </div> 69 <div class="sect3" lang="en" xml:lang="en"> 70 <div class="titlepage"> 71 <div> 72 <div> 73 <h4 class="title"><a id="id1635406"></a>bt_minkeyp</h4> 74 </div> 75 </div> 76 </div> 77 <p> 78 The <code class="methodname">Db::get_bt_minkey()</code> method returns the minimum number of 79 key/data pairs intended to be stored on any single Btree leaf page in 80 <span class="bold"><strong>bt_minkeyp</strong></span>. 81 </p> 82 </div> 83 </div> 84 <div class="sect2" lang="en" xml:lang="en"> 85 <div class="titlepage"> 86 <div> 87 <div> 88 <h3 class="title"><a id="id1635497"></a>Class</h3> 89 </div> 90 </div> 91 </div> 92 <p> 93 <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> 94 </p> 95 </div> 96 <div class="sect2" lang="en" xml:lang="en"> 97 <div class="titlepage"> 98 <div> 99 <div> 100 <h3 class="title"><a id="id1635387"></a>See Also</h3> 101 </div> 102 </div> 103 </div> 104 <p> 105 <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>, 106 <a class="xref" href="dbset_bt_minkey.html" title="Db::set_bt_minkey()">Db::set_bt_minkey()</a> 107 </p> 108 </div> 109 </div> 110 <div class="navfooter"> 111 <hr /> 112 <table width="100%" summary="Navigation footer"> 113 <tr> 114 <td width="40%" align="left"><a accesskey="p" href="dbget.html">Prev</a> </td> 115 <td width="20%" align="center"> 116 <a accesskey="u" href="db.html">Up</a> 117 </td> 118 <td width="40%" align="right"> <a accesskey="n" href="dbget_byteswapped.html">Next</a></td> 119 </tr> 120 <tr> 121 <td width="40%" align="left" valign="top">Db::get() </td> 122 <td width="20%" align="center"> 123 <a accesskey="h" href="index.html">Home</a> 124 </td> 125 <td width="40%" align="right" valign="top"> Db::get_byteswapped()</td> 126 </tr> 127 </table> 128 </div> 129 </body> 130</html> 131