1<!--$Id: memp_set_lsn_offset.so,v 10.17 2005/04/14 17:57:54 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DbMpoolFile::set_lsn_offset</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DbMpoolFile::set_lsn_offset</b> 14</td> 15<td align=right> 16<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a> 17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db_cxx.h> 23<p> 24int 25DbMpoolFile::set(int32_t lsn_offset); 26<p> 27int 28DbMpoolFile::get_lsn_offset(int32_t *lsn_offsetp); 29</pre></b> 30<hr size=1 noshade> 31<b>Description: DbMpoolFile::set_lsn_offset</b> 32<p>The DbMpoolFile::set_lsn_offset method specifies the zero-based byte offset 33of a log sequence number (<a href="/api_cxx/lsn_class.html">DbLsn</a>) on the file's pages, for the 34purposes of page-flushing as part of transaction checkpoint. (See the 35<a href="/api_cxx/memp_sync.html">DbEnv::memp_sync</a> documentation for more information.)</p> 36<p>The DbMpoolFile::set_lsn_offset method configures a file in the memory pool, not only 37operations performed using the specified <a href="/api_cxx/mempfile_class.html">DbMpoolFile</a> handle.</p> 38<p>The DbMpoolFile::set_lsn_offset method may not be called after the <a href="/api_cxx/memp_fopen.html">DbMpoolFile::open</a> method is 39called. 40If the file is already open in the memory pool when 41<a href="/api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_lsn_offset 42must be consistent with the existing file or an error will be 43returned. 44</p> 45<p>The DbMpoolFile::set_lsn_offset method 46either returns a non-zero error value 47or throws an exception that encapsulates a non-zero error value on 48failure, and returns 0 on success. 49</p> 50<b>Parameters</b> <br> 51 <b>lsn_offset</b><ul compact><li>The <b>lsn_offset</b> parameter is the zero-based byte offset of the 52log sequence number on the file's pages.</ul> 53<br> 54<hr size=1 noshade> 55<b>Description: DbMpoolFile::get_lsn_offset</b> 56<p>The DbMpoolFile::get_lsn_offset method returns the log sequence number byte offset.</p> 57<p>The DbMpoolFile::get_lsn_offset method may be called at any time during the life of the 58application.</p> 59<p>The DbMpoolFile::get_lsn_offset method 60either returns a non-zero error value 61or throws an exception that encapsulates a non-zero error value on 62failure, and returns 0 on success. 63</p> 64<b>Parameters</b> <br> 65 <b>lsn_offsetp</b><ul compact><li>The DbMpoolFile::get_lsn_offset method returns the 66log sequence number byte offset in <b>lsn_offsetp</b>.</ul> 67<br> 68<hr size=1 noshade> 69<br><b>Class</b> 70<a href="/api_cxx/env_class.html">DbEnv</a>, <a href="/api_cxx/mempfile_class.html">DbMpoolFile</a> 71<br><b>See Also</b> 72<a href="/api_cxx/memp_list.html">Memory Pools and Related Methods</a> 73</tt> 74<table width="100%"><tr><td><br></td><td align=right> 75<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 76</td></tr></table> 77<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 78</body> 79</html> 80
