1<!--$Id: memp_set_pgcookie.so,v 10.17 2005/11/30 19:46:21 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DB_MPOOLFILE->set_pgcookie</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DB_MPOOLFILE->set_pgcookie</b> 14</td> 15<td align=right> 16<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a> 17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db.h> 23<p> 24int 25DB_MPOOLFILE->set_pgcookie(DB_MPOOLFILE *mpf, DBT *pgcookie); 26<p> 27int 28DB_MPOOLFILE->get_pgcookie(DB_MPOOLFILE *mpf, DBT *dbt); 29</pre></b> 30<hr size=1 noshade> 31<b>Description: DB_MPOOLFILE->set_pgcookie</b> 32<p>The DB_MPOOLFILE->set_pgcookie method specifies a byte string that is provided 33to the functions registered to do input or output processing of the 34file's pages as they are read from or written to, the backing filesystem 35store. (See the <a href="/api_c/memp_register.html">DB_ENV->memp_register</a> documentation for more 36information.)</p> 37<p>The DB_MPOOLFILE->set_pgcookie method configures a file in the memory pool, not only 38operations performed using the specified <a href="/api_c/mempfile_class.html">DB_MPOOLFILE</a> handle.</p> 39<p>The DB_MPOOLFILE->set_pgcookie method may not be called after the <a href="/api_c/memp_fopen.html">DB_MPOOLFILE->open</a> method is 40called. 41If the file is already open in the memory pool when 42<a href="/api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_pgcookie 43will replace the existing information.</p> 44<p>The DB_MPOOLFILE->set_pgcookie method 45returns a non-zero error value on failure 46and 0 on success. 47</p> 48<b>Parameters</b> <br> 49 <b>pgcookie</b><ul compact><li>The <b>pgcookie</b> parameter is a byte string provided to the 50functions registered to do input or output processing of the file's 51pages.</ul> 52<br> 53<hr size=1 noshade> 54<b>Description: DB_MPOOLFILE->get_pgcookie</b> 55<p>The DB_MPOOLFILE->get_pgcookie method returns the byte string.</p> 56<p>The DB_MPOOLFILE->get_pgcookie method may be called at any time during the life of the 57application.</p> 58<p>The DB_MPOOLFILE->get_pgcookie method 59returns a non-zero error value on failure 60and 0 on success. 61</p> 62<b>Parameters</b> <br> 63 <b>dbt</b><ul compact><li>The DB_MPOOLFILE->get_pgcookie method returns a reference to the 64byte string in <b>dbt</b>.</ul> 65<br> 66<hr size=1 noshade> 67<br><b>Class</b> 68<a href="/api_c/env_class.html">DB_ENV</a>, <a href="/api_c/mempfile_class.html">DB_MPOOLFILE</a> 69<br><b>See Also</b> 70<a href="/api_c/memp_list.html">Memory Pools and Related Methods</a> 71</tt> 72<table width="100%"><tr><td><br></td><td align=right> 73<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 74</td></tr></table> 75<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 76</body> 77</html> 78
