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>DbEnv::get_lk_max_lockers()</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="lock.html" title="Chapter 7. The DbLock Handle" /> 11 <link rel="prev" href="envget_lk_detect.html" title="DbEnv::get_lk_detect()" /> 12 <link rel="next" href="envget_lk_max_locks.html" title="DbEnv::get_lk_max_locks()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::get_lk_max_lockers()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="envget_lk_detect.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 7. 23 The DbLock Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="envget_lk_max_locks.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="envget_lk_max_lockers"></a>DbEnv::get_lk_max_lockers()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::get_lk_max_lockers(u_int32_t *, lk_maxp);</pre> 42 <p> 43 The <code class="methodname">DbEnv::get_lk_max_lockers()</code> method returns the maximum number of 44 potential lockers. You can configure this using the 45 <a class="xref" href="envset_lk_max_lockers.html" title="DbEnv::set_lk_max_lockers()">DbEnv::set_lk_max_lockers()</a> 46 method. 47 </p> 48 <p> 49 The <code class="methodname">DbEnv::get_lk_max_lockers()</code> method may be called at any time 50 during the life of the application. 51 </p> 52 <p> 53 The <code class="methodname">DbEnv::get_lk_max_lockers()</code> <span> 54 55 <span> 56 method either returns a non-zero error value or throws an 57 exception that encapsulates a non-zero error value on 58 failure, and returns 0 on success. 59 </span> 60 </span> 61 </p> 62 <div class="sect2" lang="en" xml:lang="en"> 63 <div class="titlepage"> 64 <div> 65 <div> 66 <h3 class="title"><a id="id1678172"></a>Parameters</h3> 67 </div> 68 </div> 69 </div> 70 <div class="sect3" lang="en" xml:lang="en"> 71 <div class="titlepage"> 72 <div> 73 <div> 74 <h4 class="title"><a id="id1678305"></a>lk_maxp</h4> 75 </div> 76 </div> 77 </div> 78 <p> 79 The <code class="methodname">DbEnv::get_lk_max_lockers()</code> method returns the maximum number 80 of lockers in <span class="bold"><strong>lk_maxp</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="id1678767"></a>Errors</h3> 89 </div> 90 </div> 91 </div> 92 <p> 93 The <code class="methodname">DbEnv::get_lk_max_lockers()</code> <span> 94 95 <span> 96 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 97 exception, encapsulating one of the following non-zero errors, or return one 98 of the following non-zero errors: 99 </span> 100 </span> 101 </p> 102 <div class="sect3" lang="en" xml:lang="en"> 103 <div class="titlepage"> 104 <div> 105 <div> 106 <h4 class="title"><a id="id1678938"></a>EINVAL</h4> 107 </div> 108 </div> 109 </div> 110 <p> 111 The method was called on an environment which had been 112 opened without being configured for locking. 113 </p> 114 </div> 115 </div> 116 <div class="sect2" lang="en" xml:lang="en"> 117 <div class="titlepage"> 118 <div> 119 <div> 120 <h3 class="title"><a id="id1678443"></a>Class</h3> 121 </div> 122 </div> 123 </div> 124 <p> 125 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, 126 <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> 127 </p> 128 </div> 129 <div class="sect2" lang="en" xml:lang="en"> 130 <div class="titlepage"> 131 <div> 132 <div> 133 <h3 class="title"><a id="id1678939"></a>See Also</h3> 134 </div> 135 </div> 136 </div> 137 <p> 138 <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>, 139 <a class="xref" href="envset_lk_max_lockers.html" title="DbEnv::set_lk_max_lockers()">DbEnv::set_lk_max_lockers()</a> 140 </p> 141 </div> 142 </div> 143 <div class="navfooter"> 144 <hr /> 145 <table width="100%" summary="Navigation footer"> 146 <tr> 147 <td width="40%" align="left"><a accesskey="p" href="envget_lk_detect.html">Prev</a> </td> 148 <td width="20%" align="center"> 149 <a accesskey="u" href="lock.html">Up</a> 150 </td> 151 <td width="40%" align="right"> <a accesskey="n" href="envget_lk_max_locks.html">Next</a></td> 152 </tr> 153 <tr> 154 <td width="40%" align="left" valign="top">DbEnv::get_lk_detect() </td> 155 <td width="20%" align="center"> 156 <a accesskey="h" href="index.html">Home</a> 157 </td> 158 <td width="40%" align="right" valign="top"> DbEnv::get_lk_max_locks()</td> 159 </tr> 160 </table> 161 </div> 162 </body> 163</html> 164