File: dbsite_get_config.html

package info (click to toggle)
db5.3 5.3.28%2Bdfsg1-0.8
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 158,400 kB
  • sloc: ansic: 448,406; java: 111,824; tcl: 80,544; sh: 44,326; cs: 33,697; cpp: 21,604; perl: 14,557; xml: 10,799; makefile: 4,077; javascript: 1,998; yacc: 1,003; awk: 965; sql: 801; erlang: 342; python: 216; php: 24; asm: 14
file content (155 lines) | stat: -rw-r--r-- 6,054 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?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>DbSite::get_config()</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="rep.html" title="Chapter 11.  Replication Methods" />
    <link rel="prev" href="dbsite_close.html" title="DbSite::close()" />
    <link rel="next" href="dbsite_get_address.html" title="DbSite::get_address()" />
  </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">DbSite::get_config()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 11. 
                Replication Methods
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="dbsite_get_address.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="dbsite_get_config"></a>DbSite::get_config()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db_cxx.h&gt;

int
DbSite::get_config(u_int32_t which, u_int32_t *valuep);</pre>
      <p>
         The <code class="methodname">DbSite::get_config()</code> method returns
         whether the specified <span class="bold"><strong>which</strong></span>
         parameter is currently set.  See the 
         <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a> 
         method for the configuration flags that can be set for a
         DbSite handle.
    </p>
      <p>
         The <code class="methodname">DbSite::get_config()</code> method may be
         called at any time during the life of the application.
    </p>
      <p>
         The <code class="methodname">DbSite::get_config()</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="idp9384680"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp9384032"></a>which</h4>
              </div>
            </div>
          </div>
          <p>
                  The <span class="bold"><strong>which</strong></span> parameter is
                  the configuration flag to check.  See the
                  <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a> 
                  method for a list of configuration flags that you can
                  provide to this parameter.
             </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp9363112"></a>valuep</h4>
              </div>
            </div>
          </div>
          <p>
                  The <span class="bold"><strong>valuep</strong></span> parameter references
                  memory into which  the configuration of the specified <span class="bold"><strong>which</strong></span> parameter is copied.
             </p>
          <p>
                 If the returned value is zero, the parameter is off;
                 otherwise it is on. 
             </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp9385976"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="link" href="db_site.html" title="The DbSite Handle">DbSite</a>  
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp9376352"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>,
            <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>
        </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="dbsite_close.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="rep.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="dbsite_get_address.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DbSite::close() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DbSite::get_address()</td>
        </tr>
      </table>
    </div>
  </body>
</html>