Edit File - File Manager

Edit File: memp_set_flags.html

<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>
DbMpoolFile::set_flags
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbMpoolFile::set_flags(u_int32_t flags, bool onoff);

int
DbMpoolFile::get_flags(u_int32_t *flagsp);
</pre>
<hr size=1 noshade>
Description: DbMpoolFile::set_flags
Configure a file in the cache.
To set the flags for a particular database, call the
DbMpoolFile::set_flags method using the <a href="../../db4-devel-4.7.25/api_cxx/mempfile_class.html">DbMpoolFile</a> handle stored in
the mpf field of the <a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a> handle.
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.

Parameters 
 flags<ul compact><li>The flags parameter must be set by bitwise inclusively OR'ing together one or more
of the following values:
 
<a name="DB_MPOOL_NOFILE">DB_MPOOL_NOFILE</a><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.
The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../../db4-devel-4.7.25/api_cxx/mempfile_class.html">DbMpoolFile</a> handle.
The DB_MPOOL_NOFILE flag may be used to configure Berkeley DB at any time during
the life of the application.</ul>
<a name="DB_MPOOL_UNLINK">DB_MPOOL_UNLINK</a><ul compact><li>If set, remove the file when the last reference to it is closed.
The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../../db4-devel-4.7.25/api_cxx/mempfile_class.html">DbMpoolFile</a> handle.
The DB_MPOOL_UNLINK flag may be used to configure Berkeley DB at any time during
the life of the application.</ul>
 </ul>
 onoff<ul compact><li>If onoff is
false,
the specified flags are cleared; otherwise they are set.</ul>
 
<hr size=1 noshade>
Description: DbMpoolFile::get_flags
The DbMpoolFile::get_flags method returns the flags.
The DbMpoolFile::get_flags method may be called at any time during the life of the
application.
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.

Parameters 
 flagsp<ul compact><li>The DbMpoolFile::get_flags method returns the
flags in flagsp.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>, <a href="../../db4-devel-4.7.25/api_cxx/mempfile_class.html">DbMpoolFile</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/memp_list.html">Memory Pools and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager