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

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/memp_fset.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</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</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(void *pgaddr, u_int32_t flags);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DbMpoolFile::set method sets the flags associated with the page to which
30
 
<b>pgaddr</b> refers without unpinning it from the pool.  The
31
 
<b>pgaddr</b> argument must be an address previously returned by
32
 
<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>.
33
 
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or
34
 
more of the following values:
35
 
<p><dl compact>
36
 
<p><dt><a name="DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a><dd>Clear any previously set modification information (that is, don't bother
37
 
writing the page back to the source file).
38
 
<p><dt><a name="DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a><dd>The page has been modified and must be written to the source file before
39
 
being evicted from the pool.
40
 
<p><dt><a name="DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a><dd>The page is unlikely to be useful in the near future, and should be
41
 
discarded before other pages in the pool.
42
 
</dl>
43
 
<p>The DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags are
44
 
mutually exclusive.
45
 
<p>The DbMpoolFile::set method either returns a non-zero error value or throws an exception that
46
 
encapsulates a non-zero error value on failure, and returns 0 on success.
47
 
<h1>Errors</h1>
48
 
<p>The DbMpoolFile::set method may fail and throw an exception or return a non-zero error for the following conditions:
49
 
<p><dl compact>
50
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
51
 
</dl>
52
 
<p>The DbMpoolFile::set 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.
53
 
If a catastrophic error has occurred, the DbMpoolFile::set method may fail and
54
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
55
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
56
 
in which case all subsequent Berkeley DB calls will fail in the same way.
57
 
<h1>Class</h1>
58
 
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
59
 
<h1>See Also</h1>
60
 
<a href="../api_cxx/memp_list.html">Memory Pools and Related Methods</a>
61
 
</tt>
62
 
<table width="100%"><tr><td><br></td><td align=right>
63
 
<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>
64
 
</td></tr></table>
65
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
66
 
</body>
67
 
</html>