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