1<!--$Id: memp_fclose.so,v 10.33 2004/08/13 03:38:58 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::close</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::close</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 &lt;db_cxx.h&gt;
23<p>
24int
25DbMpoolFile::close(u_int32_t flags);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: DbMpoolFile::close</b>
29<p>The DbMpoolFile::close method closes the source file indicated by the
30<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> object.  Calling DbMpoolFile::close does not imply a call
31to <a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>; that is, no pages are written to the source file
32as as a result of calling DbMpoolFile::close.</p>
33<p>If the <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> was temporary, any underlying files created
34for this <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> will be removed.</p>
35<p>After DbMpoolFile::close has been called, regardless of its return, the
36<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle may not be accessed again.</p>
37<p>The DbMpoolFile::close method
38either returns a non-zero error value
39or throws an exception that encapsulates a non-zero error value on
40failure, and returns 0 on success.
41</p>
42<b>Parameters</b> <br>
43 <b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul>
44<br>
45<hr size=1 noshade>
46<br><b>Class</b>
47<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
48<br><b>See Also</b>
49<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
50</tt>
51<table width="100%"><tr><td><br></td><td align=right>
52<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>
53</td></tr></table>
54<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
55</body>
56</html>
57