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::rep_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="repstat.html" title="DbEnv::rep_stat()" /> 12 <link rel="next" href="repsync.html" title="DbEnv::rep_sync()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::rep_stat_print()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="repstat.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="repsync.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="repstat_print"></a>DbEnv::rep_stat_print()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::rep_stat_print(u_int32_t flags);</pre> 42 <p> 43 The <code class="methodname">DbEnv::rep_stat_print()</code> method displays the replication 44 subsystem statistical information, as described for the 45 <code class="methodname">DbEnv::rep_stat()</code> method. The information is printed to a specified 46 output channel (see the <a class="xref" href="envset_msgfile.html" title="DbEnv::set_msgfile()">DbEnv::set_msgfile()</a> 47 method for more information), or passed to an application callback 48 function (see the <a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">DbEnv::set_msgcall()</a> 49 method for more information). 50 </p> 51 <p> 52 The <code class="methodname">DbEnv::rep_stat_print()</code> method may not be called before the 53 <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is called. 54 </p> 55 <p> 56 The <code class="methodname">DbEnv::rep_stat_print()</code> <span> 57 58 <span> 59 method either returns a non-zero error value or throws an 60 exception that encapsulates a non-zero error value on 61 failure, and returns 0 on success. 62 </span> 63 </span> 64 </p> 65 <div class="sect2" lang="en" xml:lang="en"> 66 <div class="titlepage"> 67 <div> 68 <div> 69 <h3 class="title"><a id="id1706616"></a>Parameters</h3> 70 </div> 71 </div> 72 </div> 73 <div class="sect3" lang="en" xml:lang="en"> 74 <div class="titlepage"> 75 <div> 76 <div> 77 <h4 class="title"><a id="id1706689"></a>flags</h4> 78 </div> 79 </div> 80 </div> 81 <p> 82 The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 83 or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing 84 together one or more of the following values: 85 </p> 86 <div class="itemizedlist"> 87 <ul type="disc"> 88 <li> 89 <p> 90 <code class="literal">DB_STAT_ALL</code> 91 </p> 92 <p> 93 Display all available information. 94 </p> 95 </li> 96 <li> 97 <p> 98 <code class="literal">DB_STAT_CLEAR</code> 99 </p> 100 <p> 101 Reset statistics after displaying their values. 102 </p> 103 </li> 104 </ul> 105 </div> 106 </div> 107 </div> 108 <div class="sect2" lang="en" xml:lang="en"> 109 <div class="titlepage"> 110 <div> 111 <div> 112 <h3 class="title"><a id="id1706947"></a>Errors</h3> 113 </div> 114 </div> 115 </div> 116 <p> 117 The <code class="methodname">DbEnv::rep_stat_print()</code> <span> 118 119 <span> 120 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 121 exception, encapsulating one of the following non-zero errors, or return one 122 of the following non-zero errors: 123 </span> 124 </span> 125 </p> 126 <div class="sect3" lang="en" xml:lang="en"> 127 <div class="titlepage"> 128 <div> 129 <div> 130 <h4 class="title"><a id="id1706864"></a>EINVAL</h4> 131 </div> 132 </div> 133 </div> 134 <p> 135 If the method was called before <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> 136 was called; or if an invalid flag value or parameter was specified. 137 </p> 138 </div> 139 </div> 140 <div class="sect2" lang="en" xml:lang="en"> 141 <div class="titlepage"> 142 <div> 143 <div> 144 <h3 class="title"><a id="id1706805"></a>Class</h3> 145 </div> 146 </div> 147 </div> 148 <p> 149 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> 150 </p> 151 </div> 152 <div class="sect2" lang="en" xml:lang="en"> 153 <div class="titlepage"> 154 <div> 155 <div> 156 <h3 class="title"><a id="id1706870"></a>See Also</h3> 157 </div> 158 </div> 159 </div> 160 <p> 161 <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a> 162 </p> 163 </div> 164 </div> 165 <div class="navfooter"> 166 <hr /> 167 <table width="100%" summary="Navigation footer"> 168 <tr> 169 <td width="40%" align="left"><a accesskey="p" href="repstat.html">Prev</a> </td> 170 <td width="20%" align="center"> 171 <a accesskey="u" href="rep.html">Up</a> 172 </td> 173 <td width="40%" align="right"> <a accesskey="n" href="repsync.html">Next</a></td> 174 </tr> 175 <tr> 176 <td width="40%" align="left" valign="top">DbEnv::rep_stat() </td> 177 <td width="20%" align="center"> 178 <a accesskey="h" href="index.html">Home</a> 179 </td> 180 <td width="40%" align="right" valign="top"> DbEnv::rep_sync()</td> 181 </tr> 182 </table> 183 </div> 184 </body> 185</html> 186