← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_c/env_create.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_c/env_create.html
 
1
<!--$Id: env_create.so,v 10.17 2001/05/05 01:49:13 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: db_env_create</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>db_env_create</h1>
 
15
</td>
 
16
<td align=right>
 
17
<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>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
#include &lt;db.h&gt;
 
23
<p>
 
24
int
 
25
db_env_create(DB_ENV **dbenvp, u_int32_t flags);
 
26
</pre></h3>
 
27
<h1>Description</h1>
 
28
<p>The db_env_create function creates a DB_ENV structure that is the
 
29
handle for a Berkeley DB environment.  A pointer to this structure is returned
 
30
in the memory to which <b>dbenvp</b> refers.
 
31
<p>The <b>flags</b> value must be set to 0 or
 
32
the following value:
 
33
<p><dl compact>
 
34
<p><dt><a name="DB_CLIENT">DB_CLIENT</a><dd>Create a client environment to connect to a server.
 
35
<p>The DB_CLIENT flag indicates to the system that this environment
 
36
is remote on a server.  The use of this flag causes the environment
 
37
methods to use functions that call a server instead of local functions.
 
38
Prior to making any environment or database method calls, the application
 
39
must call the <a href="../api_c/env_set_rpc_server.html">DB_ENV-&gt;set_rpc_server</a> function to establish the
 
40
connection to the server.
 
41
</dl>
 
42
<p>The DB_ENV handle contains a special field, "app_private", which
 
43
is declared as type "void *".  This field is provided for the use of
 
44
the application program.  It is initialized to NULL and is not further
 
45
used by Berkeley DB in any way.
 
46
<p>The db_env_create function returns a non-zero error value on failure and 0 on success.
 
47
<h1>Errors</h1>
 
48
<p>The db_env_create function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
 
49
If a catastrophic error has occurred, the db_env_create function may fail and return
 
50
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
 
51
in the same way.
 
52
<h1>See Also</h1>
 
53
<a href="../api_c/env_create.html">db_env_create</a>,
 
54
<a href="../api_c/env_close.html">DB_ENV-&gt;close</a>,
 
55
<a href="../api_c/env_err.html">DB_ENV-&gt;err</a>, <a href="../api_c/env_err.html">DB_ENV-&gt;errx</a>
 
56
<a href="../api_c/env_open.html">DB_ENV-&gt;open</a>,
 
57
<a href="../api_c/env_remove.html">DB_ENV-&gt;remove</a>,
 
58
<a href="../api_c/env_set_alloc.html">DB_ENV-&gt;set_alloc</a>,
 
59
<a href="../api_c/env_set_cachesize.html">DB_ENV-&gt;set_cachesize</a>,
 
60
<a href="../api_c/env_set_data_dir.html">DB_ENV-&gt;set_data_dir</a>,
 
61
<a href="../api_c/env_set_errcall.html">DB_ENV-&gt;set_errcall</a>,
 
62
<a href="../api_c/env_set_errfile.html">DB_ENV-&gt;set_errfile</a>,
 
63
<a href="../api_c/env_set_errpfx.html">DB_ENV-&gt;set_errpfx</a>,
 
64
<a href="../api_c/env_set_feedback.html">DB_ENV-&gt;set_feedback</a>,
 
65
<a href="../api_c/env_set_flags.html">DB_ENV-&gt;set_flags</a>,
 
66
<a href="../api_c/env_set_mutexlocks.html">DB_ENV-&gt;set_mutexlocks</a>,
 
67
<a href="../api_c/env_set_pageyield.html">db_env_set_pageyield</a>,
 
68
<a href="../api_c/env_set_paniccall.html">DB_ENV-&gt;set_paniccall</a>,
 
69
<a href="../api_c/env_set_panicstate.html">db_env_set_panicstate</a>,
 
70
<a href="../api_c/env_set_rec_init.html">DB_ENV-&gt;set_recovery_init</a>,
 
71
<a href="../api_c/env_set_rpc_server.html">DB_ENV-&gt;set_rpc_server</a>,
 
72
<a href="../api_c/env_set_region_init.html">db_env_set_region_init</a>,
 
73
<a href="../api_c/env_set_shm_key.html">DB_ENV-&gt;set_shm_key</a>,
 
74
<a href="../api_c/env_set_tas_spins.html">db_env_set_tas_spins</a>,
 
75
<a href="../api_c/env_set_tmp_dir.html">DB_ENV-&gt;set_tmp_dir</a>,
 
76
<a href="../api_c/env_set_verbose.html">DB_ENV-&gt;set_verbose</a>,
 
77
<a href="../api_c/env_strerror.html">db_strerror</a>
 
78
and
 
79
<a href="../api_c/env_version.html">db_version</a>.
 
80
</tt>
 
81
<table width="100%"><tr><td><br></td><td align=right>
 
82
<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>
 
83
</td></tr></table>
 
84
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
85
</body>
 
86
</html>