docs/api_reference/C/mempput.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6     <title>DB_MPOOLFILE-&gt;put()</title>
   7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
   8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
   9     <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
  10     <link rel="up" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle" />
  11     <link rel="prev" href="mempfopen.html" title="DB_MPOOLFILE-&gt;open()" />
  12     <link rel="next" href="mempfsync.html" title="DB_MPOOLFILE-&gt;sync()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">DB_MPOOLFILE-&gt;put()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="mempfopen.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 8.
  26               The  DB_MPOOLFILE Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="mempfsync.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="mempput"></a>DB_MPOOLFILE-&gt;put()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db.h&gt;
  42
  43 int
  44 DB_MPOOLFILE-&gt;put(DB_MPOOLFILE *mpf,
  45     void *pgaddr, DB_CACHE_PRIORITY priority, u_int32_t flags);  </pre>
  46       <p>
  47          The <code class="methodname">DB_MPOOLFILE-&gt;put()</code> method returns a reference to a page in the
  48          cache, setting the priority of the page as specified by the <span class="bold"><strong>priority</strong></span> parameter.
  49     </p>
  50       <p>
  51          The <code class="methodname">DB_MPOOLFILE-&gt;put()</code> <span>
  52             <span>
  53                   method returns a non-zero error value on failure and 0 on success.
  54             </span>
  55
  56         </span>
  57     </p>
  58       <div class="sect2" lang="en" xml:lang="en">
  59         <div class="titlepage">
  60           <div>
  61             <div>
  62               <h3 class="title"><a id="idp61431032"></a>Parameters</h3>
  63             </div>
  64           </div>
  65         </div>
  66         <div class="sect3" lang="en" xml:lang="en">
  67           <div class="titlepage">
  68             <div>
  69               <div>
  70                 <h4 class="title"><a id="idp61430344"></a>pgaddr</h4>
  71               </div>
  72             </div>
  73           </div>
  74           <p>
  75                           The <span class="bold"><strong>pgaddr</strong></span> parameter is the address
  76                           of the page to be returned to the cache.  The <span class="bold"><strong>pgaddr</strong></span> parameter must be a value previously
  77                           returned by the
  78                           <a class="xref" href="mempfget.html" title="DB_MPOOLFILE-&gt;get()">DB_MPOOLFILE-&gt;get()</a>  method.
  79                      </p>
  80         </div>
  81         <div class="sect3" lang="en" xml:lang="en">
  82           <div class="titlepage">
  83             <div>
  84               <div>
  85                 <h4 class="title"><a id="idp61449664"></a>priority</h4>
  86               </div>
  87             </div>
  88           </div>
  89           <p>
  90                           Set the page's <span class="bold"><strong>priority</strong></span> as follows:
  91                      </p>
  92           <div class="itemizedlist">
  93             <ul type="disc">
  94               <li>
  95                 <p><a id="fput_DB_PRIORITY_UNCHANGED"></a>
  96                   <code class="literal">DB_PRIORITY_UNCHANGED</code>
  97             </p>
  98                 <p>
  99                 The priority is unchanged.
 100             </p>
 101               </li>
 102               <li>
 103                 <p>
 104                   <code class="literal">DB_PRIORITY_VERY_LOW</code>
 105             </p>
 106                 <p>
 107                  The lowest priority: pages are the most likely to be discarded.
 108             </p>
 109               </li>
 110               <li>
 111                 <p>
 112                   <code class="literal">DB_PRIORITY_LOW</code>
 113             </p>
 114                 <p>
 115                 The next lowest priority.
 116             </p>
 117               </li>
 118               <li>
 119                 <p>
 120                   <code class="literal">DB_PRIORITY_DEFAULT</code>
 121             </p>
 122                 <p>
 123                 The default priority.
 124             </p>
 125               </li>
 126               <li>
 127                 <p>
 128                   <code class="literal">DB_PRIORITY_HIGH</code>
 129             </p>
 130                 <p>
 131                 The next highest priority.
 132             </p>
 133               </li>
 134               <li>
 135                 <p>
 136                   <code class="literal">DB_PRIORITY_VERY_HIGH</code>
 137             </p>
 138                 <p>
 139                  The highest priority: pages are the least likely to be discarded.
 140             </p>
 141               </li>
 142             </ul>
 143           </div>
 144         </div>
 145         <div class="sect3" lang="en" xml:lang="en">
 146           <div class="titlepage">
 147             <div>
 148               <div>
 149                 <h4 class="title"><a id="idp61465152"></a>flags</h4>
 150               </div>
 151             </div>
 152           </div>
 153           <p>
 154                           The <span class="bold"><strong>flags</strong></span> parameter is currently
 155                           unused, and must be set to 0.
 156                      </p>
 157         </div>
 158       </div>
 159       <div class="sect2" lang="en" xml:lang="en">
 160         <div class="titlepage">
 161           <div>
 162             <div>
 163               <h3 class="title"><a id="idp61466480"></a>Errors</h3>
 164             </div>
 165           </div>
 166         </div>
 167         <p>
 168                          The <code class="methodname">DB_MPOOLFILE-&gt;put()</code> <span>
 169             <span>
 170                  method may fail and return one of the following non-zero errors:
 171             </span>
 172
 173         </span>
 174                     </p>
 175         <div class="sect3" lang="en" xml:lang="en">
 176           <div class="titlepage">
 177             <div>
 178               <div>
 179                 <h4 class="title"><a id="idp61459624"></a>EINVAL</h4>
 180               </div>
 181             </div>
 182           </div>
 183           <p>
 184                 An invalid flag value or parameter was specified.
 185             </p>
 186         </div>
 187       </div>
 188       <div class="sect2" lang="en" xml:lang="en">
 189         <div class="titlepage">
 190           <div>
 191             <div>
 192               <h3 class="title"><a id="idp61389448"></a>Class</h3>
 193             </div>
 194           </div>
 195         </div>
 196         <p>
 197                  <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>, <a class="link" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle">DB_MPOOLFILE</a>
 198             </p>
 199       </div>
 200       <div class="sect2" lang="en" xml:lang="en">
 201         <div class="titlepage">
 202           <div>
 203             <div>
 204               <h3 class="title"><a id="idp61470344"></a>See Also</h3>
 205             </div>
 206           </div>
 207         </div>
 208         <p>
 209                      <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>
 210                 </p>
 211       </div>
 212     </div>
 213     <div class="navfooter">
 214       <hr />
 215       <table width="100%" summary="Navigation footer">
 216         <tr>
 217           <td width="40%" align="left"><a accesskey="p" href="mempfopen.html">Prev</a> </td>
 218           <td width="20%" align="center">
 219             <a accesskey="u" href="memp.html">Up</a>
 220           </td>
 221           <td width="40%" align="right"> <a accesskey="n" href="mempfsync.html">Next</a></td>
 222         </tr>
 223         <tr>
 224           <td width="40%" align="left" valign="top">DB_MPOOLFILE-&gt;open() </td>
 225           <td width="20%" align="center">
 226             <a accesskey="h" href="index.html">Home</a>
 227           </td>
 228           <td width="40%" align="right" valign="top"> DB_MPOOLFILE-&gt;sync()</td>
 229         </tr>
 230       </table>
 231     </div>
 232   </body>
 233 </html>