docs/api_reference/CXX/dbsite_get_config.html

   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>DbSite::get_config()</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="rep.html" title="Chapter 11.  Replication Methods" />
  11     <link rel="prev" href="dbsite_close.html" title="DbSite::close()" />
  12     <link rel="next" href="dbsite_get_address.html" title="DbSite::get_address()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">DbSite::get_config()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 11.
  26                 Replication Methods
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="dbsite_get_address.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="dbsite_get_config"></a>DbSite::get_config()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 DbSite::get_config(u_int32_t which, u_int32_t *valuep);</pre>
  45       <p>
  46          The <code class="methodname">DbSite::get_config()</code> method returns
  47          whether the specified <span class="bold"><strong>which</strong></span>
  48          parameter is currently set.  See the
  49          <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>
  50          method for the configuration flags that can be set for a
  51          DbSite handle.
  52     </p>
  53       <p>
  54          The <code class="methodname">DbSite::get_config()</code> method may be
  55          called at any time during the life of the application.
  56     </p>
  57       <p>
  58          The <code class="methodname">DbSite::get_config()</code> <span>
  59
  60             <span>
  61                 method either returns a non-zero error value or throws an
  62                 exception that encapsulates a non-zero error value on
  63                 failure, and returns 0 on success.
  64             </span>
  65         </span>
  66     </p>
  67       <div class="sect2" lang="en" xml:lang="en">
  68         <div class="titlepage">
  69           <div>
  70             <div>
  71               <h3 class="title"><a id="idp4006400"></a>Parameters</h3>
  72             </div>
  73           </div>
  74         </div>
  75         <div class="sect3" lang="en" xml:lang="en">
  76           <div class="titlepage">
  77             <div>
  78               <div>
  79                 <h4 class="title"><a id="idp4021760"></a>which</h4>
  80               </div>
  81             </div>
  82           </div>
  83           <p>
  84                   The <span class="bold"><strong>which</strong></span> parameter is
  85                   the configuration flag to check.  See the
  86                   <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>
  87                   method for a list of configuration flags that you can
  88                   provide to this parameter.
  89              </p>
  90         </div>
  91         <div class="sect3" lang="en" xml:lang="en">
  92           <div class="titlepage">
  93             <div>
  94               <div>
  95                 <h4 class="title"><a id="idp4000728"></a>valuep</h4>
  96               </div>
  97             </div>
  98           </div>
  99           <p>
 100                   The <span class="bold"><strong>valuep</strong></span> parameter references
 101                   memory into which  the configuration of the specified <span class="bold"><strong>which</strong></span> parameter is copied.
 102              </p>
 103           <p>
 104                  If the returned value is zero, the parameter is off;
 105                  otherwise it is on.
 106              </p>
 107         </div>
 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="idp4016024"></a>Class</h3>
 114             </div>
 115           </div>
 116         </div>
 117         <p>
 118             <a class="link" href="db_site.html" title="The DbSite Handle">DbSite</a>
 119         </p>
 120       </div>
 121       <div class="sect2" lang="en" xml:lang="en">
 122         <div class="titlepage">
 123           <div>
 124             <div>
 125               <h3 class="title"><a id="idp4024152"></a>See Also</h3>
 126             </div>
 127           </div>
 128         </div>
 129         <p>
 130             <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>,
 131             <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>
 132         </p>
 133       </div>
 134     </div>
 135     <div class="navfooter">
 136       <hr />
 137       <table width="100%" summary="Navigation footer">
 138         <tr>
 139           <td width="40%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
 140           <td width="20%" align="center">
 141             <a accesskey="u" href="rep.html">Up</a>
 142           </td>
 143           <td width="40%" align="right"> <a accesskey="n" href="dbsite_get_address.html">Next</a></td>
 144         </tr>
 145         <tr>
 146           <td width="40%" align="left" valign="top">DbSite::close() </td>
 147           <td width="20%" align="center">
 148             <a accesskey="h" href="index.html">Home</a>
 149           </td>
 150           <td width="40%" align="right" valign="top"> DbSite::get_address()</td>
 151         </tr>
 152       </table>
 153     </div>
 154   </body>
 155 </html>