2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DbEnv::log_file</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DbEnv::log_file</h1>
18
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
23
#include <db_cxx.h>
26
DbEnv::log_file(const DbLsn *lsn, char *namep, size_t len);
29
<p>The DbEnv::log_file method maps
30
<a href="../api_cxx/lsn_class.html">DbLsn</a> objects
32
copying the name of the file containing the record named by <b>lsn</b>
33
into the memory location to which <b>namep</b> refers.
34
<p>The <b>len</b> argument is the length of the <b>namep</b> buffer in bytes.
35
If <b>namep</b> is too short to hold the filename, DbEnv::log_file will
37
(Log filenames are normally quite short, on the order of 10 characters.)
39
<a href="../api_cxx/lsn_class.html">DbLsn</a> objects
40
to files is needed for database administration. For example, a
41
transaction manager typically records the earliest
42
<a href="../api_cxx/lsn_class.html">DbLsn</a>
43
needed for restart, and the database administrator may want to archive
44
log files to tape when they contain only
45
<a href="../api_cxx/lsn_class.html">DbLsn</a>
46
entries before the earliest one needed for restart.
47
<p>The DbEnv::log_file method either returns a non-zero error value or throws an exception that
48
encapsulates a non-zero error value on failure, and returns 0 on success.
50
<p>The DbEnv::log_file method may fail and throw an exception or return a non-zero error for the following conditions:
52
<p><dt>ENOMEM<dd>The supplied buffer was too small to hold the log filename.
54
<p>The DbEnv::log_file method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
55
If a catastrophic error has occurred, the DbEnv::log_file method may fail and
56
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
57
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
58
in which case all subsequent Berkeley DB calls will fail in the same way.
60
<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>
62
<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
64
<table width="100%"><tr><td><br></td><td align=right>
65
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
67
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>