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
|
<!--$Id: env_class.so,v 10.42 2005/05/25 15:59:03 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_env_create</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_env_create</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 <db.h>
<p>
int
db_env_create(DB_ENV **dbenvp, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: db_env_create</h3>
<p>The DB_ENV object is the handle for a Berkeley DB environment -- a
collection including support for some or all of caching, locking,
logging and transaction subsystems, as well as databases and log files.
Methods of the DB_ENV handle are used to configure the
environment as well as to operate on subsystems and databases in the
environment.</p>
<p>DB_ENV handles are free-threaded if the <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag
is specified to the <a href="../api_c/env_open.html">DB_ENV->open</a> method when the environment is opened.
The DB_ENV handle should not be closed while any other handle
remains open that is using it as a reference (for example, <a href="../api_c/db_class.html">DB</a>
or <a href="../api_c/txn_class.html">DB_TXN</a>). Once either the <a href="../api_c/env_close.html">DB_ENV->close</a> or
<a href="../api_c/env_remove.html">DB_ENV->remove</a> methods are called, the handle may not be accessed again,
regardless of the method's return.</p>
<p>The db_env_create method creates a DB_ENV structure that is the
handle for a Berkeley DB environment. A pointer to this structure is returned
in the memory to which <b>dbenvp</b> refers. Calling the
<a href="../api_c/env_close.html">DB_ENV->close</a> or <a href="../api_c/env_remove.html">DB_ENV->remove</a> methods will discard the returned
handle.</p>
<p>The DB_ENV handle contains a special field, "app_private", which
is declared as type "void *". This field is provided for the use of
the application program. It is initialized to NULL and is not further
used by Berkeley DB in any way.</p>
<p>The db_env_create method
returns a non-zero error value on failure
and 0 on success.
</p>
The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt><a name="DB_RPCCLIENT">DB_RPCCLIENT</a><dd>Create a client environment to connect to a server.
<p>The DB_RPCCLIENT flag indicates to the system that this environment
is remote on a server. The use of this flag causes the environment
methods to use functions that call a server instead of local functions.
Prior to making any environment or database method calls, the application
must call the <a href="../api_c/env_set_rpc_server.html">DB_ENV->set_rpc_server</a> function to establish the
connection to the server.</p>
</dl>
<h3>Errors</h3>
<hr size=1 noshade>
<h3>Class</h3>
DB_ENV
<h3>See Also</h3>
<a href="../api_c/env_list.html">Database Environments 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>
|
