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_detect()</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_conflicts.html" title="DbEnv::get_lk_conflicts()" /> 12 <link rel="next" href="envget_lk_max_lockers.html" title="DbEnv::get_lk_max_lockers()" /> 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_detect()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="envget_lk_conflicts.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_lockers.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_detect"></a>DbEnv::get_lk_detect()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::get_lk_detect(u_int32_t *lk_detectp);</pre> 42 <p> 43 The <code class="methodname">DbEnv::get_lk_detect()</code> method returns the deadlock detector 44 configuration. You can manage this using the 45 <a class="xref" href="envset_lk_detect.html" title="DbEnv::set_lk_detect()">DbEnv::set_lk_detect()</a> method. 46 </p> 47 <p> 48 The <code class="methodname">DbEnv::get_lk_detect()</code> method may be called at any time during 49 the life of the application. 50 </p> 51 <p> 52 The <code class="methodname">DbEnv::get_lk_detect()</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="id1678578"></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="id1678256"></a>lk_detectp</h4> 74 </div> 75 </div> 76 </div> 77 <p> 78 The <code class="methodname">DbEnv::get_lk_detect()</code> method returns the deadlock detector 79 configuration in <span class="bold"><strong>lk_detectp</strong></span>. 80 </p> 81 </div> 82 </div> 83 <div class="sect2" lang="en" xml:lang="en"> 84 <div class="titlepage"> 85 <div> 86 <div> 87 <h3 class="title"><a id="id1678579"></a>Errors</h3> 88 </div> 89 </div> 90 </div> 91 <p> 92 The <code class="methodname">DbEnv::get_lk_detect()</code> <span> 93 94 <span> 95 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 96 exception, encapsulating one of the following non-zero errors, or return one 97 of the following non-zero errors: 98 </span> 99 </span> 100 </p> 101 <div class="sect3" lang="en" xml:lang="en"> 102 <div class="titlepage"> 103 <div> 104 <div> 105 <h4 class="title"><a id="id1678544"></a>EINVAL</h4> 106 </div> 107 </div> 108 </div> 109 <p> 110 The method was called on an environment which had been 111 opened without being configured for locking. 112 </p> 113 </div> 114 </div> 115 <div class="sect2" lang="en" xml:lang="en"> 116 <div class="titlepage"> 117 <div> 118 <div> 119 <h3 class="title"><a id="id1678257"></a>Class</h3> 120 </div> 121 </div> 122 </div> 123 <p> 124 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, 125 <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> 126 </p> 127 </div> 128 <div class="sect2" lang="en" xml:lang="en"> 129 <div class="titlepage"> 130 <div> 131 <div> 132 <h3 class="title"><a id="id1678545"></a>See Also</h3> 133 </div> 134 </div> 135 </div> 136 <p> 137 <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>, 138 <a class="xref" href="envset_lk_detect.html" title="DbEnv::set_lk_detect()">DbEnv::set_lk_detect()</a> 139 </p> 140 </div> 141 </div> 142 <div class="navfooter"> 143 <hr /> 144 <table width="100%" summary="Navigation footer"> 145 <tr> 146 <td width="40%" align="left"><a accesskey="p" href="envget_lk_conflicts.html">Prev</a> </td> 147 <td width="20%" align="center"> 148 <a accesskey="u" href="lock.html">Up</a> 149 </td> 150 <td width="40%" align="right"> <a accesskey="n" href="envget_lk_max_lockers.html">Next</a></td> 151 </tr> 152 <tr> 153 <td width="40%" align="left" valign="top">DbEnv::get_lk_conflicts() </td> 154 <td width="20%" align="center"> 155 <a accesskey="h" href="index.html">Home</a> 156 </td> 157 <td width="40%" align="right" valign="top"> DbEnv::get_lk_max_lockers()</td> 158 </tr> 159 </table> 160 </div> 161 </body> 162</html> 163