~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/memp_set_pgcookie.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbMpoolFile::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++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbMpoolFile::set_pgcookie</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
DbMpoolFile::set(DBT *pgcookie);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DbMpoolFile::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_cxx/memp_register.html">DbEnv::memp_register</a> documentation for more
33
 
information.)
34
 
<p>The DbMpoolFile::set_pgcookie method configures a file in the memory pool, not only
35
 
operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle.
36
 
<p>The DbMpoolFile::set_pgcookie interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>
37
 
interface is called.
38
 
If the file is already open in the memory pool when
39
 
<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_pgcookie
40
 
will replace the existing information.
41
 
<p>The DbMpoolFile::set_pgcookie method either returns a non-zero error value or throws an exception that
42
 
encapsulates a non-zero error value on failure, and returns 0 on success.
43
 
<h1>Errors</h1>
44
 
<p>The DbMpoolFile::set_pgcookie method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
45
 
If a catastrophic error has occurred, the DbMpoolFile::set_pgcookie method may fail and
46
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
47
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
48
 
in which case all subsequent Berkeley DB calls will fail in the same way.
49
 
<h1>Class</h1>
50
 
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
51
 
<h1>See Also</h1>
52
 
<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
53
 
</tt>
54
 
<table width="100%"><tr><td><br></td><td align=right>
55
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
56
 
</td></tr></table>
57
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
58
 
</body>
59
 
</html>