• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src/router/db-4.8.30/docs/api_reference/CXX/
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::repmgr_stat_print()</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="repmgrstat.html" title="DbEnv::repmgr_stat()" />
12    <link rel="next" href="seq.html" title="Chapter 12.  The DbSequence Handle" />
13  </head>
14  <body>
15    <div class="navheader">
16      <table width="100%" summary="Navigation header">
17        <tr>
18          <th colspan="3" align="center">DbEnv::repmgr_stat_print()</th>
19        </tr>
20        <tr>
21          <td width="20%" align="left"><a accesskey="p" href="repmgrstat.html">Prev</a> </td>
22          <th width="60%" align="center">Chapter 11. 
23                Replication Methods
24        </th>
25          <td width="20%" align="right"> <a accesskey="n" href="seq.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="repmgrstat_print"></a>DbEnv::repmgr_stat_print()</h2>
35          </div>
36        </div>
37      </div>
38      <pre class="programlisting">#include &lt;db_cxx.h&gt;
39
40int
41DbEnv::repmgr_stat_print(u_int32_t flags);</pre>
42      <p>
43         The <code class="methodname">DbEnv::repmgr_stat_print()</code> method displays the Replication
44         Manager statistical information, as described for the
45         <code class="methodname">DbEnv::repmgr_stat()</code> method. The information is printed to a
46         specified output channel (see the 
47         <a class="xref" href="envset_msgfile.html" title="DbEnv::set_msgfile()">DbEnv::set_msgfile()</a> method for more
48         information), or passed to an application callback function (see the 
49         <a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">DbEnv::set_msgcall()</a> method for more
50         information).
51    </p>
52      <p>
53         The <code class="methodname">DbEnv::repmgr_stat_print()</code> method may not be called before the
54         <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>  method is
55         called.
56    </p>
57      <p>
58         The <code class="methodname">DbEnv::repmgr_stat_print()</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="id1708823"></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="id1708767"></a>flags</h4>
80              </div>
81            </div>
82          </div>
83          <p>
84                          The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
85                          or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing
86                          together one or more of the following values:
87                     </p>
88          <div class="itemizedlist">
89            <ul type="disc">
90              <li>
91                <p>
92                  <code class="literal">DB_STAT_ALL</code>
93            </p>
94                <p>
95                Display all available information.
96            </p>
97              </li>
98              <li>
99                <p>
100                  <code class="literal">DB_STAT_CLEAR</code>
101            </p>
102                <p>
103                Reset statistics after displaying their values.
104            </p>
105              </li>
106            </ul>
107          </div>
108        </div>
109      </div>
110      <div class="sect2" lang="en" xml:lang="en">
111        <div class="titlepage">
112          <div>
113            <div>
114              <h3 class="title"><a id="id1709139"></a>Errors</h3>
115            </div>
116          </div>
117        </div>
118        <p>
119                         The <code class="methodname">DbEnv::repmgr_stat_print()</code> <span>
120            
121            <span>
122                method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 
123                exception, encapsulating one of the following non-zero errors, or return one
124                of the following non-zero errors:
125            </span>
126        </span>
127                    </p>
128        <div class="sect3" lang="en" xml:lang="en">
129          <div class="titlepage">
130            <div>
131              <div>
132                <h4 class="title"><a id="id1708762"></a>EINVAL</h4>
133              </div>
134            </div>
135          </div>
136          <p>
137                If the method was called before <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> 
138                was called; or if an invalid flag value or parameter was specified.
139            </p>
140        </div>
141      </div>
142      <div class="sect2" lang="en" xml:lang="en">
143        <div class="titlepage">
144          <div>
145            <div>
146              <h3 class="title"><a id="id1708763"></a>Class</h3>
147            </div>
148          </div>
149        </div>
150        <p>
151                 <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>  
152            </p>
153      </div>
154      <div class="sect2" lang="en" xml:lang="en">
155        <div class="titlepage">
156          <div>
157            <div>
158              <h3 class="title"><a id="id1708370"></a>See Also</h3>
159            </div>
160          </div>
161        </div>
162        <p>
163                     <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a> 
164                </p>
165      </div>
166    </div>
167    <div class="navfooter">
168      <hr />
169      <table width="100%" summary="Navigation footer">
170        <tr>
171          <td width="40%" align="left"><a accesskey="p" href="repmgrstat.html">Prev</a> </td>
172          <td width="20%" align="center">
173            <a accesskey="u" href="rep.html">Up</a>
174          </td>
175          <td width="40%" align="right"> <a accesskey="n" href="seq.html">Next</a></td>
176        </tr>
177        <tr>
178          <td width="40%" align="left" valign="top">DbEnv::repmgr_stat() </td>
179          <td width="20%" align="center">
180            <a accesskey="h" href="index.html">Home</a>
181          </td>
182          <td width="40%" align="right" valign="top"> Chapter 12. 
183                The DbSequence Handle 
184        </td>
185        </tr>
186      </table>
187    </div>
188  </body>
189</html>
190