memp_set_flags.html [plain text]
<!--$Id: memp_set_flags.so,v 1.19 2007/06/07 15:30:46 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbMpoolFile::set_flags</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::set_flags</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 <db_cxx.h>
<p>
int
DbMpoolFile::set_flags(u_int32_t flags, bool onoff);
<p>
int
DbMpoolFile::get_flags(u_int32_t *flagsp);
</pre></b>
<hr size=1 noshade>
<b>Description: DbMpoolFile::set_flags</b>
<p>Configure a file in the cache.</p>
<p>To set the flags for a particular database, call the
DbMpoolFile::set_flags method using the <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle stored in
the <b>mpf</b> field of the <a href="../api_cxx/db_class.html">Db</a> handle.</p>
<p>The DbMpoolFile::set_flags 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 must be set by bitwise inclusively <b>OR</b>'ing together one or more
of the following values:
<br>
<b><a name="DB_MPOOL_NOFILE">DB_MPOOL_NOFILE</a></b><ul compact><li>If set, no backing temporary file will be opened for the specified
in-memory database, even if it expands to fill the entire cache.
Attempts to create new database pages after the cache has been filled
will fail.
<p>The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle.</p>
<p>The DB_MPOOL_NOFILE flag may be used to configure Berkeley DB at any time during
the life of the application.</p></ul>
<b><a name="DB_MPOOL_UNLINK">DB_MPOOL_UNLINK</a></b><ul compact><li>If set, remove the file when the last reference to it is closed.
<p>The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle.</p>
<p>The DB_MPOOL_UNLINK flag may be used to configure Berkeley DB at any time during
the life of the application.</p></ul>
<br></ul>
<b>onoff</b><ul compact><li>If <b>onoff</b> is
false,
the specified flags are cleared; otherwise they are set.</ul>
<br>
<hr size=1 noshade>
<b>Description: DbMpoolFile::get_flags</b>
<p>The DbMpoolFile::get_flags method returns the flags.</p>
<p>The DbMpoolFile::get_flags method may be called at any time during the life of the
application.</p>
<p>The DbMpoolFile::get_flags 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>flagsp</b><ul compact><li>The DbMpoolFile::get_flags method returns the
flags in <b>flagsp</b>.</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>