1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>DbMpoolFile::set_lsn_offset()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> 10 <link rel="up" href="memp.html" title="Chapter 9. The DbMpoolFile Handle" /> 11 <link rel="prev" href="mempset_ftype.html" title="DbMpoolFile::set_ftype()" /> 12 <link rel="next" href="mempset_maxsize.html" title="DbMpoolFile::set_maxsize()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbMpoolFile::set_lsn_offset()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="mempset_ftype.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 9. 23 The DbMpoolFile Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="mempset_maxsize.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="mempset_lsn_offset"></a>DbMpoolFile::set_lsn_offset()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int DbMpoolFile::set_lsn_offset(int32_t lsn_offset); </pre> 41 <p> 42 The <code class="methodname">DbMpoolFile::set_lsn_offset()</code> method specifies the zero-based 43 byte offset of a log sequence number 44 (<a class="link" href="lsn.html" title="Chapter 8. The DbLsn Handle">DbLsn</a>) on the file's pages, for 45 the purposes of page-flushing as part of transaction checkpoint. (See 46 the <a class="xref" href="mempsync.html" title="DbEnv::memp_sync()">DbEnv::memp_sync()</a> 47 documentation for more information.) 48 </p> 49 <p> 50 The <code class="methodname">DbMpoolFile::set_lsn_offset()</code> method configures a file in the 51 cache, not only operations performed using the specified 52 <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> handle. 53 </p> 54 <p> 55 The <code class="methodname">DbMpoolFile::set_lsn_offset()</code> method may not be called after the 56 <a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a> 57 method is called. If the file is already open in the cache when 58 <a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a> is 59 called, the information specified to <code class="methodname">DbMpoolFile::set_lsn_offset()</code> 60 must be consistent with the existing file or an error will be returned. 61 </p> 62 <p> 63 The <code class="methodname">DbMpoolFile::set_lsn_offset()</code> <span> 64 65 <span> 66 method either returns a non-zero error value or throws an 67 exception that encapsulates a non-zero error value on 68 failure, and returns 0 on success. 69 </span> 70 </span> 71 </p> 72 <div class="sect2" lang="en" xml:lang="en"> 73 <div class="titlepage"> 74 <div> 75 <div> 76 <h3 class="title"><a id="id1697065"></a>Parameters</h3> 77 </div> 78 </div> 79 </div> 80 <div class="sect3" lang="en" xml:lang="en"> 81 <div class="titlepage"> 82 <div> 83 <div> 84 <h4 class="title"><a id="id1697056"></a>lsn_offset</h4> 85 </div> 86 </div> 87 </div> 88 <p> 89 The <span class="bold"><strong>lsn_offset</strong></span> parameter is the 90 zero-based byte offset of the log sequence number on the file's pages. 91 </p> 92 </div> 93 </div> 94 <div class="sect2" lang="en" xml:lang="en"> 95 <div class="titlepage"> 96 <div> 97 <div> 98 <h3 class="title"><a id="id1697399"></a>Class</h3> 99 </div> 100 </div> 101 </div> 102 <p> 103 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> 104 </p> 105 </div> 106 <div class="sect2" lang="en" xml:lang="en"> 107 <div class="titlepage"> 108 <div> 109 <div> 110 <h3 class="title"><a id="id1697251"></a>See Also</h3> 111 </div> 112 </div> 113 </div> 114 <p> 115 <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a> 116 </p> 117 </div> 118 </div> 119 <div class="navfooter"> 120 <hr /> 121 <table width="100%" summary="Navigation footer"> 122 <tr> 123 <td width="40%" align="left"><a accesskey="p" href="mempset_ftype.html">Prev</a> </td> 124 <td width="20%" align="center"> 125 <a accesskey="u" href="memp.html">Up</a> 126 </td> 127 <td width="40%" align="right"> <a accesskey="n" href="mempset_maxsize.html">Next</a></td> 128 </tr> 129 <tr> 130 <td width="40%" align="left" valign="top">DbMpoolFile::set_ftype() </td> 131 <td width="20%" align="center"> 132 <a accesskey="h" href="index.html">Home</a> 133 </td> 134 <td width="40%" align="right" valign="top"> DbMpoolFile::set_maxsize()</td> 135 </tr> 136 </table> 137 </div> 138 </body> 139</html> 140