<!--$Id: env_create.html,v 1.1.1.1 2003/02/15 04:55:46 zarzycki 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_create</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_create</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 <db.h> <p> int db_env_create(DB_ENV **dbenvp, u_int32_t flags); </pre></h3> <h1>Description</h1> <p>The db_env_create method creates a <a href="../api_c/env_class.html">DB_ENV</a> 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>The <b>flags</b> value must be set to 0 or the following value: <p><dl compact> <p><dt><a name="DB_CLIENT">DB_CLIENT</a><dd>Create a client environment to connect to a server. <p>The DB_CLIENT 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. </dl> <p>The <a href="../api_c/env_class.html">DB_ENV</a> 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>The db_env_create method returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The db_env_create method 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_create method 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>Class</h1> <a href="../api_c/env_class.html">DB_ENV</a> <h1>See Also</h1> <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/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>