File: memp_set_flags.html

package info (click to toggle)
db4.4 4.4.20-8
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 39,948 kB
  • ctags: 26,257
  • sloc: ansic: 124,258; tcl: 46,590; java: 28,006; perl: 13,009; sh: 11,611; cpp: 9,192; makefile: 1,972; awk: 1,339; cs: 457; xml: 112; php: 22; asm: 14
file content (88 lines) | stat: -rw-r--r-- 3,926 bytes parent folder | download
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
<!--$Id: memp_set_flags.so,v 1.18 2005/09/17 16:30:18 bostic Exp $-->
<!--Copyright 1997-2005 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_MPOOLFILE-&gt;set_flags</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DB_MPOOLFILE-&gt;set_flags</h3>
</td>
<td align=right>
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../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_flags(DB_MPOOLFILE *mpf, u_int32_t flags, int onoff)
<p>
int
DB_MPOOLFILE-&gt;get_flags(DB_MPOOLFILE *mpf, u_int32_t *flagsp);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_MPOOLFILE-&gt;set_flags</h3>
<p>Configure a file in the cache.</p>
<p>To set the flags for a particular database, call the
DB_MPOOLFILE-&gt;set_flags method using the <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a> handle stored in
the <b>mpf</b> field of the <a href="../api_c/db_class.html">DB</a> handle.</p>
<p>The DB_MPOOLFILE-&gt;set_flags method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set by bitwise inclusively <b>OR</b>'ing together one or more
of the following values:
<dl compact>
<dt><a name="DB_MPOOL_NOFILE">DB_MPOOL_NOFILE</a><dd>If set, no backing temporary file will be opened for in-memory
databases, even if they expand to fill the entire cache.  Attempts to
create new file pages after the cache has been filled will fail.
<p>The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a> handle.</p>
<p>The DB_MPOOL_NOFILE flag may be used to configure Berkeley DB at any time during
the life of the application.</p>
<dt><a name="DB_MPOOL_UNLINK">DB_MPOOL_UNLINK</a><dd>If set, remove the file when the last reference to it is closed.
<p>The DB_MPOOL_NOFILE flag configures a file in the memory pool, not only
operations performed using the specified <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a> handle.</p>
<p>The DB_MPOOL_UNLINK flag may be used to configure Berkeley DB at any time during
the life of the application.</p>
</dl>
<dt><b>onoff</b><dd>If <b>onoff</b> is
zero,
the specified flags are cleared;  otherwise they are set.
</dl>
<hr size=1 noshade>
<h3>Description: DB_MPOOLFILE-&gt;get_flags</h3>
<p>The DB_MPOOLFILE-&gt;get_flags method returns the flags.</p>
<p>The DB_MPOOLFILE-&gt;get_flags method may be called at any time during the life of the
application.</p>
<p>The DB_MPOOLFILE-&gt;get_flags method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flagsp</b><dd>The DB_MPOOLFILE-&gt;get_flags method returns  the
flags in <b>flagsp</b>.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/mempfile_class.html">DB_MPOOLFILE</a>
<h3>See Also</h3>
<a href="../api_c/memp_list.html">Memory Pools and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2005</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>