2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DbMpoolFile::set</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DbMpoolFile::set</h1>
18
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
23
#include <db_cxx.h>
26
DbMpoolFile::set(void *pgaddr, u_int32_t flags);
29
<p>The DbMpoolFile::set method sets the flags associated with the page to which
30
<b>pgaddr</b> refers without unpinning it from the pool. The
31
<b>pgaddr</b> argument must be an address previously returned by
32
<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>.
33
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or
34
more of the following values:
36
<p><dt><a name="DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a><dd>Clear any previously set modification information (that is, don't bother
37
writing the page back to the source file).
38
<p><dt><a name="DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a><dd>The page has been modified and must be written to the source file before
39
being evicted from the pool.
40
<p><dt><a name="DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a><dd>The page is unlikely to be useful in the near future, and should be
41
discarded before other pages in the pool.
43
<p>The DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags are
45
<p>The DbMpoolFile::set method either returns a non-zero error value or throws an exception that
46
encapsulates a non-zero error value on failure, and returns 0 on success.
48
<p>The DbMpoolFile::set method may fail and throw an exception or return a non-zero error for the following conditions:
50
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
52
<p>The DbMpoolFile::set method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
53
If a catastrophic error has occurred, the DbMpoolFile::set method may fail and
54
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
55
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
56
in which case all subsequent Berkeley DB calls will fail in the same way.
58
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
60
<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
62
<table width="100%"><tr><td><br></td><td align=right>
63
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
65
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>