<?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>DbEnv::set_lk_max_objects()</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="lock.html" title="Chapter 7. The DbLock Handle" /> <link rel="prev" href="envset_lk_max_locks.html" title="DbEnv::set_lk_max_locks()" /> <link rel="next" href="envset_lk_partitions.html" title="DbEnv::set_lk_partitions()" /> </head> <body> <div xmlns="" class="navheader"> <div class="libver"> <p>Library Version 11.2.5.3</p> </div> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::set_lk_max_objects()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="envset_lk_max_locks.html">Prev</a> </td> <th width="60%" align="center">Chapter 7. The DbLock Handle </th> <td width="20%" align="right"> <a accesskey="n" href="envset_lk_partitions.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="envset_lk_max_objects"></a>DbEnv::set_lk_max_objects()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::set_lk_max_objects(u_int32_t max); </pre> <p> This method is deprecated. Instead, use <a class="xref" href="envset_memory_init.html" title="DbEnv::set_memory_init()">DbEnv::set_memory_init()</a>, <a class="xref" href="envset_memory_max.html" title="DbEnv::set_memory_max()">DbEnv::set_memory_max()</a>, and <a class="xref" href="envset_lk_tablesize.html" title="DbEnv::set_lk_tablesize()">DbEnv::set_lk_tablesize()</a>. </p> <p> Set the maximum number of locked objects supported by the Berkeley DB environment. This value is used by <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> to estimate how much space to allocate for various lock-table data structures. The default value is 1000 objects. The final value specified for the lock objects should be more than or equal to the number of lock table partitions. For specific information on configuring the size of the lock subsystem, see <a href="../../programmer_reference/lock_max.html" class="olink">Configuring locking: sizing the system</a>. </p> <p> The database environment's maximum number of objects may also be configured using the environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The syntax of the entry in that file is a single line with the string "set_lk_max_objects", one or more whitespace characters, and the number of objects. Because the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read when the database environment is opened, it will silently overrule configuration done before that time. </p> <p> The <code class="methodname">DbEnv::set_lk_max_objects()</code> method configures a database environment, not only operations performed using the specified <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle. </p> <p> The <code class="methodname">DbEnv::set_lk_max_objects()</code> method may not be called after the <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is called. If the database environment already exists when <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> is called, the information specified to <code class="methodname">DbEnv::set_lk_max_objects()</code> will be ignored. </p> <p> The <code class="methodname">DbEnv::set_lk_max_objects()</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="idp7975304"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp7975904"></a>max</h4> </div> </div> </div> <p> The <span class="bold"><strong>max</strong></span> parameter is the maximum number of locked objects supported by the Berkeley DB environment. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp7965840"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DbEnv::set_lk_max_objects()</code> <span> <span> method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors: </span> </span> </p> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp7987168"></a>EINVAL</h4> </div> </div> </div> <p> If the method was called after <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> was called; or if an invalid flag value or parameter was specified. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp7988496"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp7977248"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="envset_lk_max_locks.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="lock.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="envset_lk_partitions.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::set_lk_max_locks() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::set_lk_partitions()</td> </tr> </table> </div> </body> </html>