1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbMpoolFile::set_flags()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="memp.html" title="Chapter 9. The DbMpoolFile Handle" />
<link rel="prev" href="mempset_fileid.html" title="DbMpoolFile::set_fileid()" />
<link rel="next" href="mempset_ftype.html" title="DbMpoolFile::set_ftype()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbMpoolFile::set_flags()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempset_fileid.html">Prev</a> </td>
<th width="60%" align="center">Chapter 9.
The DbMpoolFile Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="mempset_ftype.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="mempset_flags"></a>DbMpoolFile::set_flags()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbMpoolFile::set_flags(u_int32_t flags, bool onoff); </pre>
<p>
Configure a file in the cache.
</p>
<p>
To set the flags for a particular database, call the
<code class="methodname">DbMpoolFile::set_flags()</code> method using the
<a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> handle stored
in the <span class="bold"><strong>mpf</strong></span> field of the
<a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle.
</p>
<p>
The <code class="methodname">DbMpoolFile::set_flags()</code> <span>
<span>
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.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9052968"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9052320"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set by
bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing together
one or more of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="mpool_set_flags_DB_MPOOL_NOFILE"></a>
<code class="literal">DB_MPOOL_NOFILE</code>
</p>
<p>
If set, no backing temporary file will be opened for the specified
in-memory database, even if it expands to fill the entire cache.
Attempts to create new database pages after the cache has been filled
will fail.
</p>
<p>
The <code class="literal">DB_MPOOL_NOFILE</code> flag configures a file in the cache, not
only operations performed using the specified
<a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> handle.
</p>
<p>
The <code class="literal">DB_MPOOL_NOFILE</code> flag may be used to configure Berkeley DB at any
time during the life of the application.
</p>
</li>
<li>
<p>
<code class="literal">DB_MPOOL_UNLINK</code>
</p>
<p>
If set, remove the file when the last reference to it is closed.
</p>
<p>
The <code class="literal">DB_MPOOL_ULINK</code> flag configures a file in the cache, not
only operations performed using the specified
<a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> handle.
</p>
<p>
The <code class="literal">DB_MPOOL_ULINK</code> flag may be used to configure Berkeley DB at any
time during the life of the application.
</p>
</li>
</ul>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp9062640"></a>onoff</h4>
</div>
</div>
</div>
<p>
If <span class="bold"><strong>onoff</strong></span> is zero, the specified flags
are cleared; otherwise they are set.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9057232"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp9065544"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="mempset_fileid.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="memp.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="mempset_ftype.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbMpoolFile::set_fileid() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbMpoolFile::set_ftype()</td>
</tr>
</table>
</div>
</body>
</html>
|
