Edit File - File Manager

Edit File: log_file.html

<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>
DbEnv::log_file
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbEnv::log_file(const DbLsn *lsn, char *namep, size_t len);
</pre>
<hr size=1 noshade>
Description: DbEnv::log_file
The DbEnv::log_file method maps
<a href="../../db4-devel-4.7.25/api_cxx/lsn_class.html">DbLsn</a> objects
to filenames, returning the name of the file containing the record named
by lsn.
This mapping of
<a href="../../db4-devel-4.7.25/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="../../db4-devel-4.7.25/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="../../db4-devel-4.7.25/api_cxx/lsn_class.html">DbLsn</a> entries before the
earliest one needed for restart.
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.

Parameters 
 lsn<ul compact><li>The lsn parameter is the
<a href="../../db4-devel-4.7.25/api_cxx/lsn_class.html">DbLsn</a> object
for which a filename is wanted.</ul>
 namep<ul compact><li>The namep parameter references memory into which
 the name of the file containing the record named by lsn is copied.</ul> 
 len<ul compact><li>The len parameter is the length of the namep buffer in
bytes. If namep 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>
 
 Errors
The DbEnv::log_file method
may fail and throw
<a href="../../db4-devel-4.7.25/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
 
EINVAL<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>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>, <a href="../../db4-devel-4.7.25/api_cxx/logc_class.html">DbLogc</a>, <a href="../../db4-devel-4.7.25/api_cxx/lsn_class.html">DbLsn</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager