blob: 0cb069808e49128ae4a450ce4138a07fa684eded (
plain)
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
|
<?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_clear_len()</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="mempget_priority.html" title="DbMpoolFile::get_priority()" />
<link rel="next" href="mempset_fileid.html" title="DbMpoolFile::set_fileid()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 12.1.6.1</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbMpoolFile::set_clear_len()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempget_priority.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_fileid.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_clear_len"></a>DbMpoolFile::set_clear_len()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int DbMpoolFile::set_clear_len(u_int32_t len); </pre>
<p>
The <code class="methodname">DbMpoolFile::set_clear_len()</code> method sets the number of initial
bytes in a page that should be set to nul when the page is created as
a result of the
<a class="link" href="mempfget.html#mpoolfget_DB_MPOOL_CREATE">DB_MPOOL_CREATE</a>
or <a class="link" href="mempfget.html#mpoolfget_DB_MPOOL_NEW">DB_MPOOL_NEW</a>
flags specified to <a class="xref" href="mempfget.html" title="DbMpoolFile::get()">DbMpoolFile::get()</a>. If no
clear length is specified, the entire page is cleared when it is
created.
</p>
<p>
The <code class="methodname">DbMpoolFile::set_clear_len()</code> method 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="methodname">DbMpoolFile::set_clear_len()</code> method may not be called after the
<a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a>
method is called. If the file is already open in the cache when
<a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a> is
called, the information specified to <code class="methodname">DbMpoolFile::set_clear_len()</code>
must be consistent with the existing file or an error will be returned.
</p>
<p>
The <code class="methodname">DbMpoolFile::set_clear_len()</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="idp3675432"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp3674784"></a>len</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>len</strong></span> parameter is the number of
initial bytes in a page that should be set to nul when the page is
created. A value of 0 results in the entire page being set to nul
bytes.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp3666880"></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="idp3677608"></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="mempget_priority.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_fileid.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbMpoolFile::get_priority() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbMpoolFile::set_fileid()</td>
</tr>
</table>
</div>
</body>
</html>
|
