memp_set_pgcookie.html [plain text]
<!--$Id: memp_set_pgcookie.so,v 10.17 2005/11/30 19:46:21 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbMpoolFile::set_pgcookie</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>
<b>DbMpoolFile::set_pgcookie</b>
</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>
<b><pre>
#include <db_cxx.h>
<p>
int
DbMpoolFile::set(DBT *pgcookie);
<p>
int
DbMpoolFile::get_pgcookie(DBT *dbt);
</pre></b>
<hr size=1 noshade>
<b>Description: DbMpoolFile::set_pgcookie</b>
<p>The DbMpoolFile::set_pgcookie method specifies a byte string that is 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. (See the <a href="../api_cxx/memp_register.html">DbEnv::memp_register</a> documentation for more
information.)</p>
<p>The DbMpoolFile::set_pgcookie method configures a file in the memory pool, not only
operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle.</p>
<p>The DbMpoolFile::set_pgcookie method may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> method is
called.
If the file is already open in the memory pool when
<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_pgcookie
will replace the existing information.</p>
<p>The DbMpoolFile::set_pgcookie 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>
<b>Parameters</b> <br>
<b>pgcookie</b><ul compact><li>The <b>pgcookie</b> parameter is a byte string provided to the
functions registered to do input or output processing of the file's
pages.</ul>
<br>
<hr size=1 noshade>
<b>Description: DbMpoolFile::get_pgcookie</b>
<p>The DbMpoolFile::get_pgcookie method returns the byte string.</p>
<p>The DbMpoolFile::get_pgcookie method may be called at any time during the life of the
application.</p>
<p>The DbMpoolFile::get_pgcookie 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>
<b>Parameters</b> <br>
<b>dbt</b><ul compact><li>The DbMpoolFile::get_pgcookie method returns a reference to the
byte string in <b>dbt</b>.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
<br><b>See Also</b>
<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,2008 Oracle. All rights reserved.</font>
</body>
</html>