1
0
mirror of https://github.com/MariaDB/server.git synced 2025-11-09 11:41:36 +03:00
Files
mariadb/bdb/docs/api_cxx/env_set_feedback.html
2001-03-04 19:42:05 -05:00

73 lines
3.4 KiB
HTML

<!--$Id: env_set_feedback.so,v 10.19 2000/07/09 19:12:39 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbEnv::set_feedback</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table><tr valign=top>
<td>
<h1>DbEnv::set_feedback</h1>
</td>
<td width="1%">
<a href="../api_cxx/cxx_index.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>
<h3><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbEnv::set_feedback(
void (*db_feedback_fcn)(DbEnv *, int opcode, int pct));
</pre></h3>
<h1>Description</h1>
<p>Some operations performed by the Berkeley DB library can take non-trivial
amounts of time. The DbEnv::set_feedback method can be used by
applications to monitor progress within these operations.
<p>When an operation is likely to take a long time, Berkeley DB will call the
specified callback method. This method must be declared with
three arguments: the first will be a reference to the enclosing
environment, the second a flag value, and the third the percent of the
operation that has been completed, specified as an integer value between
0 and 100. It is up to the callback method to display this
information in an appropriate manner.
<p>The <b>opcode</b> argument may take on any of the following values:
<p><dl compact>
<p><dt><a name="DB_RECOVER">DB_RECOVER</a><dd>The environment is being recovered.
</dl>
<p>The DbEnv::set_feedback interface may be used to configure Berkeley DB at any time
during the life of the application.
<p>The DbEnv::set_feedback 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.
<h3>Class</h3>
<a href="../api_cxx/dbenv_class.html">DbEnv</a>
<h1>See Also</h1>
<a href="../api_cxx/env_close.html">DbEnv::close</a>,
<a href="../api_cxx/env_open.html">DbEnv::open</a>,
<a href="../api_cxx/env_remove.html">DbEnv::remove</a>,
<a href="../api_cxx/db_err.html">DbEnv::err</a>,
<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>,
<a href="../api_cxx/env_version.html">DbEnv::version</a>,
<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>,
<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>,
<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>,
<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>,
<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>,
<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>,
<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>,
<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>,
and
<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_cxx/cxx_index.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><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>