db_set_msgfile.html [plain text]
<!--$Id: db_set_msgfile.so,v 1.1 2004/07/14 19:30:39 bostic Exp $-->
<!--$Id: env_set_msgfile.so,v 10.7 2006/02/10 22:54:59 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::set_msgfile</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>
<b>Db::set_msgfile</b>
</td>
<td align=right>
<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></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>
#include <db_cxx.h>
<p>
void Db::set_msgfile(FILE *msgfile);
<p>
void Db::get_msgfile(FILE **msgfilep);
</pre></b>
<hr size=1 noshade>
<b>Description: Db::set_msgfile</b>
<p>There are interfaces in the Berkeley DB library which either directly output
informational messages or statistical information, or configure the
library to output such messages when performing other operations, for
example, <a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a> and <a href="../api_cxx/env_stat.html">DbEnv::stat_print</a>.</p>
<p>The <a href="../api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> and Db::set_msgfile methods are used to
display these messages for the application. In this case, the message
will include a trailing <newline> character.</p>
<p>Setting <b>msgfile</b> to NULL unconfigures the interface.</p>
<p>Alternatively, you can use the <a href="../api_cxx/env_set_msg_stream.html">DbEnv::set_message_stream</a> and
<a href="../api_cxx/db_set_msg_stream.html">Db::set_message_stream</a> methods to display the messages via an output
stream, or the <a href="../api_cxx/env_set_msgcall.html">DbEnv::set_msgcall</a> and <a href="../api_cxx/db_set_msgcall.html">Db::set_msgcall</a> methods
to capture the additional error information in a way that does not use
either output streams or C library FILE *'s. You should not mix these
approaches.</p>
<p>For <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the
Db::set_msgfile method affects the entire environment and is equivalent to calling
the <a href="../api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> method.</p>
<p>The Db::set_msgfile method configures operations performed using the specified
<a href="../api_cxx/db_class.html">Db</a> handle, not all operations performed on the underlying
database.</p>
<p>The Db::set_msgfile method may be called at any time during the life of the
application.</p>
<b>Parameters</b> <br>
<b>msgfile</b><ul compact><li>The <b>msgfile</b> parameter is a C library FILE * to be used for
displaying messages.</ul>
<br>
<hr size=1 noshade>
<b>Description: Db::get_msgfile</b>
<p>The Db::get_msgfile method returns the FILE *.</p>
<p>The Db::get_msgfile method may be called at any time during the life of the
application.</p>
<p>The Db::get_msgfile method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</p>
<b>Parameters</b> <br>
<b>msgfilep</b><ul compact><li>The Db::get_msgfile method returns the
FILE * in <b>msgfilep</b>.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/db_class.html">Db</a>
<br><b>See Also</b>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>