<!--$Id: memp_fput.so,v 10.34 2006/11/30 19:06:50 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbMpoolFile::put</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> <h3>DbMpoolFile::put</h3> </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> <h3><pre> #include <db_cxx.h> <p> int DbMpoolFile::put(void *pgaddr, DB_CACHE_PRIORITY priority, u_int32_t flags); </pre></h3> <hr size=1 noshade> <h3>Description: DbMpoolFile::put</h3> <p>The DbMpoolFile::put method returns a reference to a page in the cache, setting the priority of the page as specified by the <b>priority</b> parameter.</p> <p>The DbMpoolFile::put 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> <h3>Parameters</h3> <dl compact> <dt><b>flags</b><dd>The <b>flags</b> parameter is currently unused, and must be set to 0. <dt><b>pgaddr</b><dd>The <b>pgaddr</b> parameter is the address of the page to be returned to the cache. The <b>pgaddr</b> parameter must be a value previously returned by the <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a> method. <dt><b>priority</b><dd>Set the page's <b>priority</b> as follows: <dl compact> <dt><a name="DB_PRIORITY_UNCHANGED">DB_PRIORITY_UNCHANGED</a><dd>The priority is unchanged. <dt><a name="DB_PRIORITY_VERY_LOW">DB_PRIORITY_VERY_LOW</a><dd>The lowest priority: pages are the most likely to be discarded. <dt><a name="DB_PRIORITY_LOW">DB_PRIORITY_LOW</a><dd>The next lowest priority. <dt><a name="DB_PRIORITY_DEFAULT">DB_PRIORITY_DEFAULT</a><dd>The default priority. <dt><a name="DB_PRIORITY_HIGH">DB_PRIORITY_HIGH</a><dd>The next highest priority. <dt><a name="DB_PRIORITY_VERY_HIGH">DB_PRIORITY_VERY_HIGH</a><dd>The highest priority: pages are the least likely to be discarded. </dl> </dl> <h3>Errors</h3> <p>The DbMpoolFile::put method may fail and throw <a href="../api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <dl compact> <dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h3>See Also</h3> <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,2007 Oracle. All rights reserved.</font> </body> </html>