Sophie

Sophie

distrib > Mandriva > 2007.0 > x86_64 > media > main-release > by-pkgid > a4c98df40e78f6c892308fd6841f950a > files > 151

lib64db4.2-devel-4.2.52-11mdv2007.0.x86_64.rpm

<!--$Id: memp_set_clear_len.so,v 10.14 2003/11/08 19:17:40 bostic Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_MPOOLFILE-&gt;set_clear_len</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h3>DB_MPOOLFILE-&gt;set_clear_len</h3>
</td>
<td align=right>
<a href="../../db42-devel-4.2.52/api_c/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a>
<a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
DB_MPOOLFILE-&gt;set_clear_len(DB_MPOOLFILE *mpf, u_int32_t len);
<p>
int
DB_MPOOLFILE-&gt;get_clear_len(DB_MPOOLFILE *mpf, u_int32_t *lenp);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_MPOOLFILE-&gt;set_clear_len</h3>
<a name="3"><!--meow--></a>
<p>The DB_MPOOLFILE-&gt;set_clear_len 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 href="../../db42-devel-4.2.52/api_c/memp_fget.html#DB_MPOOL_CREATE">DB_MPOOL_CREATE</a> or <a href="../../db42-devel-4.2.52/api_c/memp_fget.html#DB_MPOOL_NEW">DB_MPOOL_NEW</a> flags being
specified to <a href="../../db42-devel-4.2.52/api_c/memp_fget.html">DB_MPOOLFILE-&gt;get</a>.  If no value is specified, or <b>len</b>
is 0, the entire page is cleared.</p>
<p>The DB_MPOOLFILE-&gt;set_clear_len method configures a file in the memory pool, not only
operations performed using the specified <a href="../../db42-devel-4.2.52/api_c/mempfile_class.html">DB_MPOOLFILE</a> handle.</p>
<p>The DB_MPOOLFILE-&gt;set_clear_len method may not be called after the <a href="../../db42-devel-4.2.52/api_c/memp_fopen.html">DB_MPOOLFILE-&gt;open</a> method is
called.
If the file is already open in the memory pool when
<a href="../../db42-devel-4.2.52/api_c/memp_fopen.html">DB_MPOOLFILE-&gt;open</a> is called, the information specified to DB_MPOOLFILE-&gt;set_clear_len
must be consistent with the existing file or an error will be
returned.
</p>
<p>The DB_MPOOLFILE-&gt;set_clear_len method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>len</b><dd>
The <b>len</b> 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.
</dl>
<hr size=1 noshade>
<h3>Description: DB_MPOOLFILE-&gt;get_clear_len</h3>
<p>The DB_MPOOLFILE-&gt;get_clear_len method returns the bytes to be cleared.</p>
<p>The DB_MPOOLFILE-&gt;get_clear_len method may be called at any time during the life of the
application.</p>
<p>The DB_MPOOLFILE-&gt;get_clear_len method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>lenp</b><dd>
The DB_MPOOLFILE-&gt;get_clear_len method returns  the
bytes to be cleared in <b>lenp</b>.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../../db42-devel-4.2.52/api_c/env_class.html">DB_ENV</a>, <a href="../../db42-devel-4.2.52/api_c/mempfile_class.html">DB_MPOOLFILE</a>
<h3>See Also</h3>
<a href="../../db42-devel-4.2.52/api_c/memp_list.html">Memory Pools and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db42-devel-4.2.52/api_c/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>