2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DbMpoolFile::set_lsn_offset</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>DbMpoolFile::set_lsn_offset</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
DbMpoolFile::set(int32_t lsn_offset);
29
<p>The DbMpoolFile::set_lsn_offset method specifies the zero-based byte offset
30
of a log sequence number (<a href="../api_cxx/lsn_class.html">DbLsn</a>) on the file's pages, for the
31
purposes of page-flushing as part of transaction checkpoint. (See the
32
<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> documentation for more information.)
33
<p>The DbMpoolFile::set_lsn_offset method configures a file in the memory pool, not only
34
operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle.
35
<p>The DbMpoolFile::set_lsn_offset interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>
37
If the file is already open in the memory pool when
38
<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_lsn_offset
39
must be consistent with the existing file or an error will be
41
<p>The DbMpoolFile::set_lsn_offset method either returns a non-zero error value or throws an exception that
42
encapsulates a non-zero error value on failure, and returns 0 on success.
44
<p>The DbMpoolFile::set_lsn_offset 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.
45
If a catastrophic error has occurred, the DbMpoolFile::set_lsn_offset method may fail and
46
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
47
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
48
in which case all subsequent Berkeley DB calls will fail in the same way.
50
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
52
<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
54
<table width="100%"><tr><td><br></td><td align=right>
55
<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>
57
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>