db_set_errcall.html [plain text]
<!--$Id: db_set_errcall.html,v 1.2 2004/03/30 01:21:42 jtownsen Exp $-->
<!--$Id: db_set_errcall.html,v 1.2 2004/03/30 01:21:42 jtownsen Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB->set_errcall</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h3>DB->set_errcall</h3>
</td>
<td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
void
DB->set_errcall(DB *,
void (*db_errcall_fcn)(const char *errpfx, char *msg));
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB->set_errcall</h3>
<p>When an error occurs in the Berkeley DB library, a Berkeley DB error or an error
return value is returned by the interface. In some cases, however,
the <b>errno</b> value may be insufficient to completely describe
the cause of the error, especially during initial application debugging.</p>
<p>The <a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a> and DB->set_errcall 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
<b>db_errcall_fcn</b> with additional error information. It is up to
the <b>db_errcall_fcn</b> function to display the error message in an
appropriate manner.</p>
<p>Alternatively, you can use the <a href="../api_c/db_set_errfile.html">DB->set_errfile</a> or
<a href="../api_c/env_set_errfile.html">DB_ENV->set_errfile</a> methods to display the additional information via
a C library FILE *.</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>For <a href="../api_c/db_class.html">DB</a> handles opened inside of Berkeley DB environments, calling the
DB->set_errcall method affects the entire environment and is equivalent to calling
the <a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a> method.</p>
<p>The DB->set_errcall method may be called at any time during the life of the
application.</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>db_errcall_fcn</b><dd>
The <b>db_errcall_fcn</b> parameter is the application-specified error
reporting function. The function takes two parameters:
<p><dl compact>
<p><dt><b>errpfx</b><dd>The <b>errpfx</b> parameter is the prefix string (as previously set by
<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> or <a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a>).
<p><dt><b>msg</b><dd>The <b>msg</b> parameter is the error message string.
</dl>
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/db_class.html">DB</a>
<h3>See Also</h3>
<a href="../api_c/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>