2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DB_MPOOLFILE->set_pgcookie</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DB_MPOOLFILE->set_pgcookie</h1>
18
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
26
DB_MPOOLFILE->set_pgcookie(DB_MPOOLFILE *mpf, DBT *pgcookie);
29
<p>The DB_MPOOLFILE->set_pgcookie method specifies a byte string that is provided
30
to the functions registered to do input or output processing of the
31
file's pages as they are read from or written to, the backing filesystem
32
store. (See the <a href="../api_c/memp_register.html">DB_ENV->memp_register</a> documentation for more
34
<p>The DB_MPOOLFILE->set_pgcookie method configures a file in the memory pool, not only
35
operations performed using the specified <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a> handle.
36
<p>The DB_MPOOLFILE->set_pgcookie interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>
38
If the file is already open in the memory pool when
39
<a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_pgcookie
40
will replace the existing information.
41
<p>The DB_MPOOLFILE->set_pgcookie method returns a non-zero error value on failure and 0 on success.
43
<p>The DB_MPOOLFILE->set_pgcookie method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
44
If a catastrophic error has occurred, the DB_MPOOLFILE->set_pgcookie method may fail and
45
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
46
in which case all subsequent Berkeley DB calls will fail in the same way.
48
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a>
50
<a href="../api_c/memp_list.html">Memory Pools and Related Methods</a>
52
<table width="100%"><tr><td><br></td><td align=right>
53
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
55
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>