docs/api_reference/CXX/mempget_pgcookie.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>DbMpoolFile::get_pgcookie()</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 9.  The DbMpoolFile Handle" />
  11     <link rel="prev" href="mempget_maxsize.html" title="DbMpoolFile::get_maxsize()" />
  12     <link rel="next" href="mempget_priority.html" title="DbMpoolFile::get_priority()" />
  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">DbMpoolFile::get_pgcookie()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="mempget_maxsize.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 9.
  26               The  DbMpoolFile Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="mempget_priority.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="mempget_pgcookie"></a>DbMpoolFile::get_pgcookie()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 DbMpoolFile::get_pgcookie(DBT *dbt);</pre>
  45       <p>
  46         The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method returns the byte string provided
  47         to the functions registered to do input or output processing of the file's pages as they are
  48         read from or written to, the backing filesystem store. This byte string is configured using
  49         the <a class="xref" href="mempset_pgcookie.html" title="DbMpoolFile::set_pgcookie()">DbMpoolFile::set_pgcookie()</a> method.
  50     </p>
  51       <p>
  52          The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method may be called at any time
  53          during the life of the application.
  54     </p>
  55       <p>
  56          The <code class="methodname">DbMpoolFile::get_pgcookie()</code> <span>
  57
  58             <span>
  59                 method either returns a non-zero error value or throws an
  60                 exception that encapsulates a non-zero error value on
  61                 failure, and returns 0 on success.
  62             </span>
  63         </span>
  64     </p>
  65       <div class="sect2" lang="en" xml:lang="en">
  66         <div class="titlepage">
  67           <div>
  68             <div>
  69               <h3 class="title"><a id="idp3650968"></a>Parameters</h3>
  70             </div>
  71           </div>
  72         </div>
  73         <div class="sect3" lang="en" xml:lang="en">
  74           <div class="titlepage">
  75             <div>
  76               <div>
  77                 <h4 class="title"><a id="idp3650448"></a>dbt</h4>
  78               </div>
  79             </div>
  80           </div>
  81           <p>
  82                           The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method returns a reference to the
  83                           byte string in <span class="bold"><strong>dbt</strong></span>.
  84                      </p>
  85         </div>
  86       </div>
  87       <div class="sect2" lang="en" xml:lang="en">
  88         <div class="titlepage">
  89           <div>
  90             <div>
  91               <h3 class="title"><a id="idp3641896"></a>Class</h3>
  92             </div>
  93           </div>
  94         </div>
  95         <p>
  96                  <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>, <a class="link" href="memp.html" title="Chapter 9.  The DbMpoolFile Handle">DbMpoolFile</a>
  97             </p>
  98       </div>
  99       <div class="sect2" lang="en" xml:lang="en">
 100         <div class="titlepage">
 101           <div>
 102             <div>
 103               <h3 class="title"><a id="idp3649736"></a>See Also</h3>
 104             </div>
 105           </div>
 106         </div>
 107         <p>
 108                      <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>,
 109                     <a class="xref" href="mempset_pgcookie.html" title="DbMpoolFile::set_pgcookie()">DbMpoolFile::set_pgcookie()</a>
 110                 </p>
 111       </div>
 112     </div>
 113     <div class="navfooter">
 114       <hr />
 115       <table width="100%" summary="Navigation footer">
 116         <tr>
 117           <td width="40%" align="left"><a accesskey="p" href="mempget_maxsize.html">Prev</a> </td>
 118           <td width="20%" align="center">
 119             <a accesskey="u" href="memp.html">Up</a>
 120           </td>
 121           <td width="40%" align="right"> <a accesskey="n" href="mempget_priority.html">Next</a></td>
 122         </tr>
 123         <tr>
 124           <td width="40%" align="left" valign="top">DbMpoolFile::get_maxsize() </td>
 125           <td width="20%" align="center">
 126             <a accesskey="h" href="index.html">Home</a>
 127           </td>
 128           <td width="40%" align="right" valign="top"> DbMpoolFile::get_priority()</td>
 129         </tr>
 130       </table>
 131     </div>
 132   </body>
 133 </html>