summaryrefslogtreecommitdiff
path: root/db/docs/api_c/memp_fcreate.html
blob: 34ab2e92b565cb4330acea5b125f5fa0b249a071 (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
<!--Id: memp_fcreate.so,v 10.5 2002/06/24 14:49:26 bostic Exp -->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV-&gt;memp_fcreate</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>
<h1>DB_ENV-&gt;memp_fcreate</h1>
</td>
<td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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_ENV-&gt;memp_fcreate(DB_ENV *dbenvp, DB_MPOOLFILE **dbmfp, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DB_ENV-&gt;memp_fcreate function creates a DbMpoolFile structure that
is the handle for a Berkeley DB shared memory buffer pool file.  A pointer to
this structure is returned in the memory to which <b>dbmfp</b> refers.
Calling the <a href="../api_c/memp_fclose.html">DB_MPOOLFILE-&gt;close</a> function will discard the returned handle.
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
<p>The DB_ENV-&gt;memp_fcreate function returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The DB_ENV-&gt;memp_fcreate function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB_ENV-&gt;memp_fcreate function may fail and
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>See Also</h1>
<a href="../api_c/env_set_cachesize.html">DB_ENV-&gt;set_cachesize</a>,
<a href="../api_c/env_set_mp_mmapsize.html">DB_ENV-&gt;set_mp_mmapsize</a>,
<a href="../api_c/memp_register.html">DB_ENV-&gt;memp_register</a>,
<a href="../api_c/memp_stat.html">DB_ENV-&gt;memp_stat</a>,
<a href="../api_c/memp_sync.html">DB_ENV-&gt;memp_sync</a>,
<a href="../api_c/memp_trickle.html">DB_ENV-&gt;memp_trickle</a>,
<p>
<a href="../api_c/memp_fcreate.html">DB_ENV-&gt;memp_fcreate</a>,
<a href="../api_c/memp_fclose.html">DB_MPOOLFILE-&gt;close</a>,
<a href="../api_c/memp_fget.html">DB_MPOOLFILE-&gt;get</a>,
<a href="../api_c/memp_fopen.html">DB_MPOOLFILE-&gt;open</a>,
<a href="../api_c/memp_fput.html">DB_MPOOLFILE-&gt;put</a>,
<a href="../api_c/memp_fset.html">DB_MPOOLFILE-&gt;set</a>,
<a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE-&gt;set_fileid</a>,
<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE-&gt;set_clear_len</a>,
<a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE-&gt;set_ftype</a>,
<a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE-&gt;set_lsn_offset</a>,
<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE-&gt;set_pgcookie</a>
and
<a href="../api_c/memp_fsync.html">DB_MPOOLFILE-&gt;sync</a>.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>