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::close()</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="envset_mp_mmapsize.html" title="DbEnv::set_mp_mmapsize()" /> 12 <link rel="next" href="mempfget.html" title="DbMpoolFile::get()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbMpoolFile::close()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="envset_mp_mmapsize.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="mempfget.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="mempfclose"></a>DbMpoolFile::close()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbMpoolFile::close(u_int32_t flags);</pre> 42 <p> 43 The <code class="methodname">DbMpoolFile::close()</code> method closes the source file indicated by 44 the <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> structure. Calling 45 <code class="methodname">DbMpoolFile::close()</code> does not imply a call to 46 <a class="xref" href="mempfsync.html" title="DbMpoolFile::sync()">DbMpoolFile::sync()</a>; 47 that is, no pages are written to the source file as as a result of 48 calling <code class="methodname">DbMpoolFile::close.()</code>. 49 </p> 50 <p> 51 If the <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> was temporary, any underlying files created for this 52 <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> will be removed. 53 </p> 54 <p> 55 After <code class="methodname">DbMpoolFile::close()</code> has been called, regardless of its 56 return, the <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> handle may not 57 be accessed again. 58 </p> 59 <p> 60 The <code class="methodname">DbMpoolFile::close()</code> <span> 61 62 <span> 63 method either returns a non-zero error value or throws an 64 exception that encapsulates a non-zero error value on 65 failure, and returns 0 on success. 66 </span> 67 </span> 68 </p> 69 <div class="sect2" lang="en" xml:lang="en"> 70 <div class="titlepage"> 71 <div> 72 <div> 73 <h3 class="title"><a id="id1693206"></a>Parameters</h3> 74 </div> 75 </div> 76 </div> 77 <div class="sect3" lang="en" xml:lang="en"> 78 <div class="titlepage"> 79 <div> 80 <div> 81 <h4 class="title"><a id="id1693612"></a>flags</h4> 82 </div> 83 </div> 84 </div> 85 <p> 86 The <span class="bold"><strong>flags</strong></span> parameter is currently 87 unused, and must be set to 0. 88 </p> 89 </div> 90 </div> 91 <div class="sect2" lang="en" xml:lang="en"> 92 <div class="titlepage"> 93 <div> 94 <div> 95 <h3 class="title"><a id="id1693120"></a>Class</h3> 96 </div> 97 </div> 98 </div> 99 <p> 100 <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> 101 </p> 102 </div> 103 <div class="sect2" lang="en" xml:lang="en"> 104 <div class="titlepage"> 105 <div> 106 <div> 107 <h3 class="title"><a id="id1693672"></a>See Also</h3> 108 </div> 109 </div> 110 </div> 111 <p> 112 <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a> 113 </p> 114 </div> 115 </div> 116 <div class="navfooter"> 117 <hr /> 118 <table width="100%" summary="Navigation footer"> 119 <tr> 120 <td width="40%" align="left"><a accesskey="p" href="envset_mp_mmapsize.html">Prev</a> </td> 121 <td width="20%" align="center"> 122 <a accesskey="u" href="memp.html">Up</a> 123 </td> 124 <td width="40%" align="right"> <a accesskey="n" href="mempfget.html">Next</a></td> 125 </tr> 126 <tr> 127 <td width="40%" align="left" valign="top">DbEnv::set_mp_mmapsize() </td> 128 <td width="20%" align="center"> 129 <a accesskey="h" href="index.html">Home</a> 130 </td> 131 <td width="40%" align="right" valign="top"> DbMpoolFile::get()</td> 132 </tr> 133 </table> 134 </div> 135 </body> 136</html> 137