Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
77
docs/api_cxx/log_file.html
Normal file
77
docs/api_cxx/log_file.html
Normal file
@@ -0,0 +1,77 @@
|
||||
<!--$Id: log_file.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
||||
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
||||
<!--See the file LICENSE for redistribution information.-->
|
||||
<html>
|
||||
<head>
|
||||
<title>Berkeley DB: DbEnv::log_file</title>
|
||||
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
|
||||
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
|
||||
</head>
|
||||
<body bgcolor=white>
|
||||
<table width="100%"><tr valign=top>
|
||||
<td>
|
||||
<b>DbEnv::log_file</b>
|
||||
</td>
|
||||
<td align=right>
|
||||
<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></td>
|
||||
</tr></table>
|
||||
<hr size=1 noshade>
|
||||
<tt>
|
||||
<b><pre>
|
||||
#include <db_cxx.h>
|
||||
<p>
|
||||
int
|
||||
DbEnv::log_file(const DbLsn *lsn, char *namep, size_t len);
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbEnv::log_file</b>
|
||||
<p>The DbEnv::log_file method maps
|
||||
<a href="../api_cxx/lsn_class.html">DbLsn</a> objects
|
||||
to filenames, returning the name of the file containing the record named
|
||||
by <b>lsn</b>.</p>
|
||||
<p>This mapping of
|
||||
<a href="../api_cxx/lsn_class.html">DbLsn</a> objects
|
||||
to files is needed for database administration. For example, a
|
||||
transaction manager typically records the earliest <a href="../api_cxx/lsn_class.html">DbLsn</a> needed
|
||||
for restart, and the database administrator may want to archive log
|
||||
files to tape when they contain only <a href="../api_cxx/lsn_class.html">DbLsn</a> entries before the
|
||||
earliest one needed for restart.</p>
|
||||
<p>The DbEnv::log_file 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.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>lsn</b><ul compact><li>The <b>lsn</b> parameter is the
|
||||
<a href="../api_cxx/lsn_class.html">DbLsn</a> object
|
||||
for which a filename is wanted.</ul>
|
||||
<b>namep</b><ul compact><li>The <b>namep</b> parameter references memory into which
|
||||
the name of the file containing the record named by <b>lsn</b> is copied.</ul>
|
||||
<b>len</b><ul compact><li>The <b>len</b> parameter is the length of the <b>namep</b> buffer in
|
||||
bytes. If <b>namep</b> is too short to hold the filename,
|
||||
DbEnv::log_file will fail. (Log filenames are normally quite short,
|
||||
on the order of 10 characters.)</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DbEnv::log_file method
|
||||
may fail and throw
|
||||
<a href="../api_cxx/except_class.html">DbException</a>,
|
||||
encapsulating one of the following non-zero errors, or return one of
|
||||
the following non-zero errors:</p>
|
||||
<br>
|
||||
<b>EINVAL</b><ul compact><li>If supplied buffer was too small to hold the log filename; or if an
|
||||
invalid flag value or parameter was specified.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<br><b>Class</b>
|
||||
<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>
|
||||
<br><b>See Also</b>
|
||||
<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
|
||||
</tt>
|
||||
<table width="100%"><tr><td><br></td><td align=right>
|
||||
<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>
|
||||
</td></tr></table>
|
||||
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user