Edit File - File Manager

Edit File: db_err.html

<html>
<head>
<title>Berkeley DB: Db::err</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
Db::err
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

Db::err(int error, const char *fmt, ...);

Db::errx(const char *fmt, ...);
</pre>
<hr size=1 noshade>
Description: Db::err
The <a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::err</a>, <a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::errx</a>, Db::err and
Db::errx methods provide error-messaging functionality for
applications written using the Berkeley DB library.
The Db::err and <a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::err</a> methods constructs an error message
consisting of the following elements:
<blockquote> 
An optional prefix string<ul compact><li>If no error callback function has been set using the
<a href="../../db4-devel-4.7.25/api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method, any prefix string specified using the
<a href="../../db4-devel-4.7.25/api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a> method, followed by two separating characters: a colon
and a &lt;space&gt; character.</ul>
An optional printf-style message<ul compact><li>The supplied message fmt, if non-NULL, in which the
ANSI C X3.159-1989 (ANSI C) printf function specifies how subsequent parameters
are converted for output.</ul>
A separator<ul compact><li>Two separating characters: a colon and a &lt;space&gt; character.</ul>
A standard error string<ul compact><li>The standard system or Berkeley DB library error string associated with the
error value, as returned by the <a href="../../db4-devel-4.7.25/api_cxx/env_strerror.html">DbEnv::strerror</a> method.</ul>
 
</blockquote>
The Db::errx and <a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::errx</a> methods are the same as the
Db::err and <a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::err</a> methods, except they do not append the
final separator characters and standard error string to the error
message.
This constructed error message is then handled as follows:
<blockquote>If an error callback function has been set (see <a href="../../db4-devel-4.7.25/api_cxx/db_set_errcall.html">Db::set_errcall</a>
and <a href="../../db4-devel-4.7.25/api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>), that function is called with two
parameters: any prefix string specified (see <a href="../../db4-devel-4.7.25/api_cxx/db_set_errpfx.html">Db::set_errpfx</a> and
<a href="../../db4-devel-4.7.25/api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>) and the error message.
If a C library FILE * has been set (see <a href="../../db4-devel-4.7.25/api_cxx/db_set_errfile.html">Db::set_errfile</a> and
<a href="../../db4-devel-4.7.25/api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>), the error message is written to that output
stream.
If a C++ ostream has been set
(see <a href="../../db4-devel-4.7.25/api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> and <a href="../../db4-devel-4.7.25/api_cxx/db_set_error_stream.html">Db::set_error_stream</a>),
the error message is written to that stream.
If none of these output options has been configured, the error message
is written to stderr, the standard error output stream.</blockquote>
Parameters 
 error<ul compact><li>The error parameter is the error value for which the
<a href="../../db4-devel-4.7.25/api_cxx/env_err.html">DbEnv::err</a> and Db::err methods will display a explanatory
string.</ul>
 fmt<ul compact><li>The fmt parameter is an optional printf-style message to display.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager