|
Server : Apache/2.4.62 System : FreeBSD fbsdweb2.web.rcn.net 14.1-RELEASE FreeBSD 14.1-RELEASE releng/14.1-n267679-10e31f0946d8 GENERIC amd64 User : www ( 80) PHP Version : 8.3.8 Disable Function : NONE Directory : /usr/local/share/doc/db18/api_reference/CXX/ |
Upload File : |
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbMpoolFile::get_pgcookie()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="memp.html" title="Chapter 9. The DbMpoolFile Handle" />
<link rel="prev" href="mempget_maxsize.html" title="DbMpoolFile::get_maxsize()" />
<link rel="next" href="mempget_priority.html" title="DbMpoolFile::get_priority()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 18.1.40</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">
<span xmlns="http://www.w3.org/1999/xhtml">DbMpoolFile::get_pgcookie()</span>
</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempget_maxsize.html">Prev</a> </td>
<th width="60%" align="center">Chapter 9.
The DbMpoolFile Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="mempget_priority.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="mempget_pgcookie"></a>
<span>DbMpoolFile::get_pgcookie()</span>
</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbMpoolFile::get_pgcookie(DBT *dbt);</pre>
<p>
The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method returns the byte string provided
to the functions registered to do input or output processing of the file's pages as they are
read from or written to, the backing filesystem store. This byte string is configured using
the <a class="xref" href="mempset_pgcookie.html" title="DbMpoolFile::set_pgcookie()">
<span>DbMpoolFile::set_pgcookie()</span>
</a> method.
</p>
<p>
The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method may be called at any time
during the life of the application.
</p>
<p>
The <code class="methodname">DbMpoolFile::get_pgcookie()</code> <span>
<span>
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.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139755611857408"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm139755611859472"></a>dbt</h4>
</div>
</div>
</div>
<p>
The <code class="methodname">DbMpoolFile::get_pgcookie()</code> method returns a reference to the
byte string in <span class="bold"><strong>dbt</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139755611889120"></a>Class</h3>
</div>
</div>
</div>
<p>
<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>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm139755611882896"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>,
<a class="xref" href="mempset_pgcookie.html" title="DbMpoolFile::set_pgcookie()">
<span>DbMpoolFile::set_pgcookie()</span>
</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="mempget_maxsize.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="memp.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="mempget_priority.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span>DbMpoolFile::get_maxsize()</span>
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top">
<span>DbMpoolFile::get_priority()</span>
</td>
</tr>
</table>
</div>
</body>
</html>