libdb/docs/api_reference/C/envset_msgfile.html
2012-11-14 16:35:20 -05:00

148 lines
6 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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_ENV-&gt;set_msgfile()</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="env.html" title="Chapter 5.  The DB_ENV Handle" />
<link rel="prev" href="envset_msgcall.html" title="DB_ENV-&gt;set_msgcall()" />
<link rel="next" href="envset_shm_key.html" title="DB_ENV-&gt;set_shm_key()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV-&gt;set_msgfile()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envset_msgcall.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
The DB_ENV Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_shm_key.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="envset_msgfile"></a>DB_ENV-&gt;set_msgfile()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
void
DB_ENV-&gt;set_msgfile(DB_ENV *dbenv, FILE *msgfile); </pre>
<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 class="xref" href="envset_verbose.html" title="DB_ENV-&gt;set_verbose()">DB_ENV-&gt;set_verbose()</a> and
<a class="xref" href="envstat.html" title="DB_ENV-&gt;stat_print()">DB_ENV-&gt;stat_print()</a>.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;set_msgfile()</code> and
<a class="xref" href="dbset_msgfile.html" title="DB-&gt;set_msgfile()">DB-&gt;set_msgfile()</a> methods
are used to display these messages for the application. In this case
the message will include a trailing &lt;newline&gt; character.
</p>
<p>
Setting <span class="bold"><strong>msgfile</strong></span> to NULL unconfigures
the interface.
</p>
<p>
Alternatively, you can use the
<a class="xref" href="envset_msgcall.html" title="DB_ENV-&gt;set_msgcall()">DB_ENV-&gt;set_msgcall()</a> or
<a class="xref" href="dbset_msgcall.html" title="DB-&gt;set_msgcall()">DB-&gt;set_msgcall()</a>
methods to capture the additional error information in a way that does
not use C library FILE *'s.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;set_msgfile()</code> method configures operations performed
using the specified <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a> handle, not all
operations performed on the underlying database environment.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;set_msgfile()</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="idp60171432"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp60177960"></a>msgfile</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>msgfile</strong></span> parameter is a C library
FILE * to be used for displaying messages.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp60173136"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp60183224"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments 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="envset_msgcall.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_shm_key.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;set_msgcall() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;set_shm_key()</td>
</tr>
</table>
</div>
</body>
</html>