81 lines
3.6 KiB
HTML
81 lines
3.6 KiB
HTML
<!--$Id: env_set_msgfile.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
|
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
|
<!--See the file LICENSE for redistribution information.-->
|
|
<html>
|
|
<head>
|
|
<title>Berkeley DB: DbEnv::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>DbEnv::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
|
|
DbEnv::set_msgfile(FILE *msgfile);
|
|
<p>
|
|
void
|
|
DbEnv::get_msgfile(FILE **msgfilep);
|
|
</pre></b>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbEnv::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 DbEnv::set_msgfile and <a href="../api_cxx/db_set_msgfile.html">Db::set_msgfile</a> 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>The DbEnv::set_msgfile method configures operations performed using the specified
|
|
<a href="../api_cxx/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
|
|
database environment.</p>
|
|
<p>The DbEnv::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: DbEnv::get_msgfile</b>
|
|
<p>The DbEnv::get_msgfile method returns the FILE *.</p>
|
|
<p>The DbEnv::get_msgfile method may be called at any time during the life of the
|
|
application.</p>
|
|
<p>The DbEnv::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 DbEnv::get_msgfile method returns the
|
|
FILE * in <b>msgfilep</b>.</ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<br><b>Class</b>
|
|
<a href="../api_cxx/env_class.html">DbEnv</a>
|
|
<br><b>See Also</b>
|
|
<a href="../api_cxx/env_list.html">Database Environments 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>
|