memp_fclose.html   [plain text]


<!--$Id: memp_fclose.so,v 10.33 2004/08/13 03:38:58 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbMpoolFile::close</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>DbMpoolFile::close</b>
</td>
<td align=right>
<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></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbMpoolFile::close(u_int32_t flags);
</pre></b>
<hr size=1 noshade>
<b>Description: DbMpoolFile::close</b>
<p>The DbMpoolFile::close method closes the source file indicated by the
<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> object.  Calling DbMpoolFile::close does not imply a call
to <a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>; that is, no pages are written to the source file
as as a result of calling DbMpoolFile::close.</p>
<p>If the <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> was temporary, any underlying files created
for this <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> will be removed.</p>
<p>After DbMpoolFile::close has been called, regardless of its return, the
<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle may not be accessed again.</p>
<p>The DbMpoolFile::close 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.
</p>
<b>Parameters</b> <br>
 <b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
<br><b>See Also</b>
<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>