|
Server : Apache/2.4.62 System : FreeBSD fbsdweb2.web.rcn.net 14.1-RELEASE FreeBSD 14.1-RELEASE releng/14.1-n267679-10e31f0946d8 GENERIC amd64 User : www ( 80) PHP Version : 8.3.8 Disable Function : NONE Directory : /usr/local/share/doc/db5/api_reference/C/ |
Upload File : |
<?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_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="db.html" title="Chapter 2. The DB Handle" />
<link rel="prev" href="dbset_msgcall.html" title="DB->set_msgcall()" />
<link rel="next" href="dbset_pagesize.html" title="DB->set_pagesize()" />
</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->set_msgfile()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_msgcall.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_pagesize.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_msgfile"></a>DB->set_msgfile()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
void
DB->set_msgfile(DB *db, 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->set_verbose()">DB_ENV->set_verbose()</a> and
<a class="xref" href="envstat.html" title="DB_ENV->stat_print()">DB_ENV->stat_print()</a>.
</p>
<p>
The <a class="xref" href="envset_msgfile.html" title="DB_ENV->set_msgfile()">DB_ENV->set_msgfile()</a> and
<code class="methodname">DB->set_msgfile()</code> methods are used to display these messages for the
application. In this case the message will include a trailing
<newline> 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->set_msgcall()">DB_ENV->set_msgcall()</a> or
<a class="xref" href="dbset_msgcall.html" title="DB->set_msgcall()">DB->set_msgcall()</a>
methods to capture the additional error information in a way that does
not use C library FILE *'s.
</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_msgfile()</code>
method affects the entire environment and is equivalent to calling the
<a class="xref" href="envset_msgfile.html" title="DB_ENV->set_msgfile()">DB_ENV->set_msgfile()</a>
method.
</p>
<p>
The <code class="methodname">DB->set_msgfile()</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_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="idp50461704"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50461896"></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="idp50469568"></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="idp50452200"></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_msgcall.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_pagesize.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB->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->set_pagesize()</td>
</tr>
</table>
</div>
</body>
</html>