<?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>DB->set_errfile()</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="db.html" title="Chapter 2. The DB Handle" />
<link rel="prev" href="dbset_errcall.html" title="DB->set_errcall()" />
<link rel="next" href="dbset_errpfx.html" title="DB->set_errpfx()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB->set_errfile()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_errcall.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The DB Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbset_errpfx.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="dbset_errfile"></a>DB->set_errfile()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
void
DB->set_errfile(DB *db, FILE *errfile); </pre>
<p>
When an error occurs in the Berkeley DB library,
<span>
a Berkeley DB error
</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 <a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a> and
<code class="methodname">DB->set_errfile()</code> methods are used to enhance the mechanism for
reporting error messages to the application by setting a C library
FILE * to be used for displaying additional Berkeley DB error
messages. In some cases, when an error occurs, Berkeley DB will
output an additional error message to the specified file reference.
</p>
<p>
Alternatively, you can use the
<a class="xref" href="envset_errcall.html" title="DB_ENV->set_errcall()">DB_ENV->set_errcall()</a> or
<a class="xref" href="dbset_errcall.html" title="DB->set_errcall()">DB->set_errcall()</a>
methods to capture the additional error information in a way that does
not use C library FILE *'s.
</p>
<p>
The error message will consist of the prefix string and a colon
("<span class="bold"><strong>:</strong></span>") (if a prefix string was
previously specified using
<a class="xref" href="dbset_errpfx.html" title="DB->set_errpfx()">DB->set_errpfx()</a> or
<a class="xref" href="envset_errpfx.html" title="DB_ENV->set_errpfx()">DB_ENV->set_errpfx()</a> ), an
error string, and a trailing <newline> character.
</p>
<p>
The default configuration when applications first create
<a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a> or
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> handles is as if the
<a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a> or
<code class="methodname">DB->set_errfile()</code> methods were called with the standard error output
(stderr) specified as the FILE * argument. Applications wanting no
output at all can turn off this default configuration by calling the
<a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a> or
<code class="methodname">DB->set_errfile()</code> methods with NULL as the FILE * argument.
Additionally, explicitly configuring the error output channel using
any of the following methods will also turn off this default output for the application:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="methodname">DB->set_errfile()</code>
</p>
</li>
<li>
<p>
<a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a>
</p>
</li>
<li>
<p>
<a class="xref" href="envset_errcall.html" title="DB_ENV->set_errcall()">DB_ENV->set_errcall()</a>
</p>
</li>
<li>
<p>
<a class="xref" href="dbset_errcall.html" title="DB->set_errcall()">DB->set_errcall()</a>
</p>
</li>
</ul>
</div>
<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 class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a> handles opened
inside of Berkeley DB environments, calling the
<code class="methodname">DB->set_errfile()</code>
method affects the entire environment and is equivalent to calling the
<a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a>
method.
</p>
<p>
When used on a database that was <span class="emphasis"><em>not</em></span> opened in
an environment, the <code class="methodname">DB->set_errfile()</code>
method configures operations performed using the specified
<a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a> handle, not all operations
performed on the underlying database.
</p>
<p>
The <code class="methodname">DB->set_errfile()</code> method may be called at any time during the
life of the application.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1645626"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id1645565"></a>errfile</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>errfile</strong></span> parameter is a C library
<code class="literal">FILE *</code> to be used for displaying additional Berkeley DB error
information.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1645910"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1645837"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database 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="dbset_errcall.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbset_errpfx.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB->set_errcall() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB->set_errpfx()</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
a00abf5f94bf470fd4cc9e10b2d135e0
>
files
>
138
