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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
<?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>DbEnv::set_errcall()</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="env.html" title="Chapter 5. The DbEnv Handle" />
<link rel="prev" href="envevent_notify.html" title="DbEnv::set_event_notify()" />
<link rel="next" href="envset_errfile.html" title="DbEnv::set_errfile()" />
</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">DbEnv::set_errcall()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envevent_notify.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_errfile.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="envset_errcall"></a>DbEnv::set_errcall()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
void DbEnv::set_errcall(void (*db_errcall_fcn)
(const Dbenv *dbenv, const char *errpfx, const char *msg));</pre>
<p>
When an error occurs in the Berkeley DB library,
<span>
an exception is thrown
</span>
or an error return value is returned by the interface. In some cases,
however, the <span class="bold"><strong>errno</strong></span> value may be
insufficient to completely describe the cause of the error, especially
during initial application debugging.
</p>
<p>
The <code class="methodname">DbEnv::set_errcall()</code> and
<a class="xref" href="envset_errcall.html" title="DbEnv::set_errcall()">DbEnv::set_errcall()</a> methods
are used to enhance the mechanism for reporting error messages to the
application. In some cases, when an error occurs, Berkeley DB will
call <span class="bold"><strong>db_errcall_fcn</strong></span> with additional
error information. It is up to the <span class="bold"><strong>db_errcall_fcn</strong></span> function to display the error
message in an appropriate manner.
</p>
<p>
Setting <span class="bold"><strong>db_errcall_fcn</strong></span> to NULL
unconfigures the callback interface.
</p>
<p>
Alternatively, you can use the
<span>
<a class="xref" href="envset_error_stream.html" title="DbEnv::set_error_stream()">DbEnv::set_error_stream()</a>
and
<a class="xref" href="dbset_error_stream.html" title="Db::set_error_stream()">Db::set_error_stream()</a>
methods to display the additional information via an output stream, or the
</span>
<a class="xref" href="dbset_errfile.html" title="Db::set_errfile()">Db::set_errfile()</a> or
<a class="xref" href="envset_errfile.html" title="DbEnv::set_errfile()">Db::set_errfile()</a>
methods to display the additional information via a C library <code class="literal">FILE *</code>.
<span>You should not mix these approaches.</span>
</p>
<p>
This error-logging enhancement does not slow performance or
significantly increase application size, and may be run during normal
operation as well as during application debugging.
</p>
<p>
The <code class="methodname">DbEnv::set_errcall()</code> method configures operations performed
using the specified <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle, not all
operations performed on the underlying database environment.
</p>
<p>
The <code class="methodname">DbEnv::set_errcall()</code> method may be called at any time during the
life of the application.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Berkeley DB is not re-entrant. Callback functions should not attempt to make library
calls (for example, to release locks or close open handles). Re-entering Berkeley DB is
not guaranteed to work correctly, and the results are undefined.
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7264552"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7246152"></a>db_errcall_fcn</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>db_errcall_fcn</strong></span> parameter is the
application-specified error reporting function. The function takes
three parameters:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span> parameter is the enclosing
database environment.
</p>
</li>
<li>
<p>
<code class="literal">errpfx</code>
</p>
<p>
The <span class="bold"><strong>errpfx</strong></span> parameter is the prefix
string (as previously set by
<a class="xref" href="dbset_errpfx.html" title="Db::set_errpfx()">Db::set_errpfx()</a> or
<a class="xref" href="envset_errpfx.html" title="DbEnv::set_errpfx()">DbEnv::set_errpfx()</a>).
</p>
</li>
<li>
<p>
<code class="literal">msg</code>
</p>
<p>
The <span class="bold"><strong>msg</strong></span> parameter is the error
message string.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7329904"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7253288"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envevent_notify.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_errfile.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::set_event_notify() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::set_errfile()</td>
</tr>
</table>
</div>
</body>
</html>
|
