1<!--$Id: env_set_verbose.so,v 10.56 2008/01/19 14:12:57 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DbEnv::set_verbose</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DbEnv::set_verbose</b>
14</td>
15<td align=right>
16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25DbEnv::set_verbose(u_int32_t which, int onoff);
26<p>
27int
28DbEnv::get_verbose(u_int32_t which, int *onoffp);
29</pre></b>
30<hr size=1 noshade>
31<b>Description: DbEnv::set_verbose</b>
32<p>The DbEnv::set_verbose method turns specific additional informational
33and debugging messages in the Berkeley DB message output on and off.  To see
34the additional messages, verbose messages must also be configured for
35the application.  For more information on verbose messages, see the
36<a href="../api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> method.</p>
37<p>The database environment's messages may also be configured using the
38environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.  The syntax of the entry in that
39file is a single line with the string "set_verbose", one or more whitespace
40characters, and the method <b>which</b> parameter as a string; for example,
41"set_verbose DB_VERB_RECOVERY".
42Because the <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file is read when the database environment
43is opened, it will silently overrule configuration done before that
44time.</p>
45<p>The DbEnv::set_verbose method configures operations performed using the specified
46<a href="../api_cxx/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
47database environment.</p>
48<p>The DbEnv::set_verbose method may be called at any time during the life of the
49application.</p>
50<p>The DbEnv::set_verbose method
51either returns a non-zero error value
52or throws an exception that encapsulates a non-zero error value on
53failure, and returns 0 on success.
54</p>
55<b>Parameters</b> <br>
56 <b>onoff</b><ul compact><li>If the <b>onoff</b> parameter is set to non-zero, the additional
57messages are output.</ul>
58 <b>which</b><ul compact><li>The <b>which</b> parameter must be set to one of the following values:
59<br>
60<b><a name="DB_VERB_DEADLOCK">DB_VERB_DEADLOCK</a></b><ul compact><li>Display additional information when doing deadlock detection.</ul>
61<b><a name="DB_VERB_FILEOPS">DB_VERB_FILEOPS</a></b><ul compact><li>Display additional information when performing filesystem operations
62such as open, close or rename.  May not be available on all platforms.</ul>
63<b><a name="DB_VERB_FILEOPS_ALL">DB_VERB_FILEOPS_ALL</a></b><ul compact><li>Display additional information when performing all filesystem operations,
64including read and write.  May not be available on all platforms.</ul>
65<b><a name="DB_VERB_RECOVERY">DB_VERB_RECOVERY</a></b><ul compact><li>Display additional information when performing recovery.</ul>
66<b><a name="DB_VERB_REGISTER">DB_VERB_REGISTER</a></b><ul compact><li>Display additional information concerning support for the
67<a href="../api_cxx/env_open.html#DB_REGISTER">DB_REGISTER</a> flag to the <a href="../api_cxx/env_open.html">DbEnv::open</a> method.</ul>
68<b><a name="DB_VERB_REPLICATION">DB_VERB_REPLICATION</a></b><ul compact><li>Display all detailed information about replication. This includes the
69information displayed by all of the other DB_VERB_REP_* and DB_VERB_REPMGR_*
70values.</ul>
71<b><a name="DB_VERB_REP_ELECT">DB_VERB_REP_ELECT</a></b><ul compact><li>Display detailed information about replication elections.</ul>
72<b><a name="DB_VERB_REP_LEASE">DB_VERB_REP_LEASE</a></b><ul compact><li>Display detailed information about replication master leases.</ul>
73<b><a name="DB_VERB_REP_MISC">DB_VERB_REP_MISC</a></b><ul compact><li>Display detailed information about general replication processing not
74covered by the other DB_VERB_REP_* values.</ul>
75<b><a name="DB_VERB_REP_MSGS">DB_VERB_REP_MSGS</a></b><ul compact><li>Display detailed information about replication message processing.</ul>
76<b><a name="DB_VERB_REP_SYNC">DB_VERB_REP_SYNC</a></b><ul compact><li>Display detailed information about replication client synchronization.</ul>
77<b><a name="DB_VERB_REPMGR_CONNFAIL">DB_VERB_REPMGR_CONNFAIL</a></b><ul compact><li>Display detailed information about Replication Manager connection failures.</ul>
78<b><a name="DB_VERB_REPMGR_MISC">DB_VERB_REPMGR_MISC</a></b><ul compact><li>Display detailed information about general Replication Manager processing.</ul>
79<b><a name="DB_VERB_WAITSFOR">DB_VERB_WAITSFOR</a></b><ul compact><li>Display the waits-for table when doing deadlock detection.</ul>
80<br></ul>
81<br>
82<br><b>Errors</b>
83<p>The DbEnv::set_verbose method
84may fail and throw
85<a href="../api_cxx/except_class.html">DbException</a>,
86encapsulating one of the following non-zero errors, or return one of
87the following non-zero errors:</p>
88<br>
89<b>EINVAL</b><ul compact><li>An
90invalid flag value or parameter was specified.</ul>
91<br>
92<hr size=1 noshade>
93<b>Description: <a href="../api_cxx/env_set_verbose.html">DbEnv::get_verbose</a></b>
94<p>The <a href="../api_cxx/env_set_verbose.html">DbEnv::get_verbose</a> method returns whether the specified <b>which</b>
95parameter is currently set or not.</p>
96<p>The <a href="../api_cxx/env_set_verbose.html">DbEnv::get_verbose</a> method may be called at any time during the life of the
97application.</p>
98<p>The <a href="../api_cxx/env_set_verbose.html">DbEnv::get_verbose</a> method
99either returns a non-zero error value
100or throws an exception that encapsulates a non-zero error value on
101failure, and returns 0 on success.
102</p>
103<b>Parameters</b> <br>
104 <b>which</b><ul compact><li>The <b>which</b> parameter is the message value for which configuration
105is being checked.</ul>
106 <b>onoffp</b><ul compact><li>The <b>onoffp</b> parameter references memory into which
107 the configuration of the specified <b>which</b> parameter is copied.</ul> If the returned <b>onoff</b> value is zero, the parameter is off;
108otherwise on.
109<br>
110<hr size=1 noshade>
111<br><b>Class</b>
112<a href="../api_cxx/env_class.html">DbEnv</a>
113<br><b>See Also</b>
114<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
115</tt>
116<table width="100%"><tr><td><br></td><td align=right>
117<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
118</td></tr></table>
119<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
120</body>
121</html>
122