1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<!--$Id: log_file.so,v 10.32 2003/11/08 19:17:36 bostic Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV->log_file</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 width="100%"><tr valign=top>
<td>
<h3>DB_ENV->log_file</h3>
</td>
<td align=right>
<a href="../api_c/api_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 <db.h>
<p>
int
DB_ENV->log_file(DB_ENV *env,
const DB_LSN *lsn, char *namep, size_t len);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_ENV->log_file</h3>
<p>The DB_ENV->log_file method maps
DB_LSN structures
to filenames, returning the name of the file containing the record named
by <b>lsn</b>.</p>
<p>This mapping of
DB_LSN structures
to files is needed for database administration. For example, a
transaction manager typically records the earliest <a href="../api_c/lsn_class.html">DB_LSN</a> needed
for restart, and the database administrator may want to archive log
files to tape when they contain only <a href="../api_c/lsn_class.html">DB_LSN</a> entries before the
earliest one needed for restart.</p>
<p>The DB_ENV->log_file method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>lsn</b><dd>
The <b>lsn</b> parameter is the
DB_LSN structure
for which a filename is wanted.
<p><dt><b>namep</b><dd>
The <b>namep</b> parameter references memory into which
the name of the file containing the record named by <b>lsn</b> is copied.
<p><dt><b>len</b><dd>
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,
DB_ENV->log_file will fail. (Log filenames are normally quite short,
on the order of 10 characters.)
</dl>
<h3>Errors</h3>
<p>The DB_ENV->log_file method
may fail and return one of the following non-zero errors:</p>
<p><dl compact>
<p><dt>ENOMEM<dd>The supplied buffer was too small to hold the log filename.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/logc_class.html">DB_LOGC</a>, <a href="../api_c/lsn_class.html">DB_LSN</a>
<h3>See Also</h3>
<a href="../api_c/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_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="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|
