summaryrefslogtreecommitdiff
path: root/db/docs/api_cxx/memp_set_lsn_offset.html
blob: 05891ba4c18ad6668fd4b5a11f699c788c48c47b (plain)
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
<!--Id: memp_set_lsn_offset.so,v 10.2 2001/10/22 15:24:37 bostic Exp -->
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbMpoolFile::set_lsn_offset</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>
<h1>DbMpoolFile::set_lsn_offset</h1>
</td>
<td align=right>
<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>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbMpoolFile::set(int32_t lsn_offset);
</pre></h3>
<h1>Description</h1>
<p>The DbMpoolFile::set_lsn_offset method specifies the zero-based byte offset
of a log sequence number (<a href="../api_cxx/lsn_class.html">DbLsn</a>) on the file's pages, for the
purposes of page-flushing as part of transaction checkpoint.  (See the
<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> documentation for more information.)
<p>The DbMpoolFile::set_lsn_offset 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.
<h1>Errors</h1>
<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.
If a catastrophic error has occurred, the DbMpoolFile::set_lsn_offset method may fail and either
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
in the same way.
<h1>Class</h1>
<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
<h1>See Also</h1>
<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>,
<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>,
<a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>,
<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>,
<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>,
<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>,
<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>,
<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>,
<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>,
<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>,
<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>,
<a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>,
<a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>,
<a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>,
<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>,
<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>,
<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>,
and
<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>