1<!--$Id: log_flush.so,v 10.31 2004/08/13 03:38:57 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DbEnv::log_flush</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DbEnv::log_flush</b>
14</td>
15<td align=right>
16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25DbEnv::log_flush(const DbLsn *lsn);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: DbEnv::log_flush</b>
29<p>The DbEnv::log_flush method writes log records to disk.</p>
30<p>The DbEnv::log_flush method
31either returns a non-zero error value
32or throws an exception that encapsulates a non-zero error value on
33failure, and returns 0 on success.
34</p>
35<b>Parameters</b> <br>
36 <b>lsn</b><ul compact><li>All log records with <a href="../api_cxx/lsn_class.html">DbLsn</a> values less than or equal to the
37<b>lsn</b> parameter are written to disk.  If <b>lsn</b> is NULL,
38all records in the log are flushed.</ul>
39<br>
40<br><b>Errors</b>
41<p>The DbEnv::log_flush method
42may fail and throw
43<a href="../api_cxx/except_class.html">DbException</a>,
44encapsulating one of the following non-zero errors, or return one of
45the following non-zero errors:</p>
46<br>
47<b>EINVAL</b><ul compact><li>An
48invalid flag value or parameter was specified.</ul>
49<br>
50<hr size=1 noshade>
51<br><b>Class</b>
52<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a>, <a href="../api_cxx/lsn_class.html">DbLsn</a>
53<br><b>See Also</b>
54<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
55</tt>
56<table width="100%"><tr><td><br></td><td align=right>
57<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>
58</td></tr></table>
59<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
60</body>
61</html>
62