mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
243 lines
8.6 KiB
HTML
243 lines
8.6 KiB
HTML
<?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>DbEnv::msg()</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 DbEnv Handle" />
|
||
<link rel="prev" href="envlsn_reset.html" title="DbEnv::lsn_reset()" />
|
||
<link rel="next" href="envopen.html" title="DbEnv::open()" />
|
||
</head>
|
||
<body>
|
||
<div xmlns="" class="navheader">
|
||
<div class="libver">
|
||
<p>Library Version 18.1.40</p>
|
||
</div>
|
||
<table width="100%" summary="Navigation header">
|
||
<tr>
|
||
<th colspan="3" align="center">
|
||
|
||
<span xmlns="http://www.w3.org/1999/xhtml">DbEnv::msg()</span>
|
||
</th>
|
||
</tr>
|
||
<tr>
|
||
<td width="20%" align="left"><a accesskey="p" href="envlsn_reset.html">Prev</a> </td>
|
||
<th width="60%" align="center">Chapter 5.
|
||
The DbEnv Handle
|
||
</th>
|
||
<td width="20%" align="right"> <a accesskey="n" href="envopen.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="envmsg"></a>
|
||
|
||
<span>DbEnv::msg()</span>
|
||
</h2>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<pre class="programlisting">#include <db_cxx.h>
|
||
|
||
DbEnv::msg(const char *fmt, ...); </pre>
|
||
<p>
|
||
The <code class="methodname">DbEnv::msg()</code> and
|
||
<a class="xref" href="dbmsg.html" title="Db::msg()">
|
||
|
||
<span>Db::msg()</span>
|
||
</a> methods provide
|
||
informational messaging functionality for applications written using the
|
||
Berkeley DB library.
|
||
</p>
|
||
<p>
|
||
The <a class="xref" href="dbmsg.html" title="Db::msg()">
|
||
|
||
<span>Db::msg()</span>
|
||
</a> and
|
||
<a class="xref" href="envmsg.html" title="DbEnv::msg()">
|
||
|
||
<span>DbEnv::msg()</span>
|
||
</a>
|
||
methods constructs an informational message consisting of the
|
||
following elements:
|
||
</p>
|
||
<div class="itemizedlist">
|
||
<ul type="disc">
|
||
<li>
|
||
<p>
|
||
<span class="bold"><strong>An optional prefix string</strong></span>
|
||
</p>
|
||
<p>
|
||
If no informational callback function has been set using the
|
||
<a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">
|
||
|
||
<span>DbEnv::set_msgcall()</span>
|
||
</a>
|
||
method, any prefix string specified using the
|
||
<a class="xref" href="envset_msgpfx.html" title="DbEnv::set_msgpfx()">
|
||
|
||
<span>DbEnv::set_msgpfx()</span>
|
||
</a>
|
||
method.
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
<span class="bold"><strong>An optional printf-style message</strong></span>
|
||
</p>
|
||
<p>
|
||
The supplied message <span class="bold"><strong>fmt</strong></span>, if
|
||
non-NULL, in which the ANSI C X3.159-1989 (ANSI C) printf function
|
||
specifies how subsequent parameters are converted for output.
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<p>
|
||
This constructed informational message is then handled as follows:
|
||
</p>
|
||
<div class="itemizedlist">
|
||
<ul type="disc">
|
||
<li>
|
||
<p>
|
||
If an informational callback function has been set (see
|
||
<a class="xref" href="dbset_msgcall.html" title="Db::set_msgcall()">
|
||
|
||
<span>Db::set_msgcall()</span>
|
||
</a> and
|
||
<a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">
|
||
|
||
<span>DbEnv::set_msgcall()</span>
|
||
</a>),
|
||
that function is called with two parameters: any prefix string
|
||
specified (see <a class="xref" href="dbset_msgpfx.html" title="Db::set_msgpfx()">
|
||
|
||
<span>Db::set_msgpfx()</span>
|
||
</a>
|
||
and <a class="xref" href="envset_msgpfx.html" title="DbEnv::set_msgpfx()">
|
||
|
||
<span>DbEnv::set_msgpfx()</span>
|
||
</a>) and
|
||
the informational message.
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
If a C library FILE * has been set (see
|
||
<a class="xref" href="dbset_msgfile.html" title="Db::set_msgfile()">
|
||
|
||
<span>Db::set_msgfile()</span>
|
||
</a> and
|
||
<a class="xref" href="envset_msgfile.html" title="DbEnv::set_msgfile()">
|
||
|
||
<span>DbEnv::set_msgfile()</span>
|
||
</a>),
|
||
the informational message is written to that output stream.
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
If a C++ ostream has been set (see
|
||
<a class="xref" href="envset_message_stream.html" title="DbEnv::set_message_stream()">DbEnv::set_message_stream()</a>
|
||
and
|
||
<a class="xref" href="dbset_message_stream.html" title="Db::set_message_stream()">Db::set_message_stream()</a>),
|
||
the informational message is written to that stream.
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<p>
|
||
If none of these output options have been configured, the message
|
||
is written to stdout, the standard output stream.
|
||
</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Note</h3>
|
||
<p>
|
||
The total length of the message written by this method,
|
||
including the prefix string, can be no longer than 4096.
|
||
</p>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="idm139755615677520"></a>Parameters</h3>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h4 class="title"><a id="idm139755615642128"></a>fmt</h4>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>
|
||
The <span class="bold"><strong>fmt</strong></span> parameter is an optional
|
||
printf-style message to display.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="idm139755615648144"></a>Class</h3>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>
|
||
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
|
||
</p>
|
||
</div>
|
||
<div class="sect2" lang="en" xml:lang="en">
|
||
<div class="titlepage">
|
||
<div>
|
||
<div>
|
||
<h3 class="title"><a id="idm139755615631840"></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="envlsn_reset.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="envopen.html">Next</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td width="40%" align="left" valign="top">
|
||
|
||
<span>DbEnv::lsn_reset()</span>
|
||
</td>
|
||
<td width="20%" align="center">
|
||
<a accesskey="h" href="index.html">Home</a>
|
||
</td>
|
||
<td width="40%" align="right" valign="top">
|
||
|
||
<span>DbEnv::open()</span>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
</body>
|
||
</html>
|