1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>open_db</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" /> 10 <link rel="up" href="dbstl_global_functions.html" title="Chapter 1. Dbstl Global Public Functions" /> 11 <link rel="prev" href="stldbstl_global_functionsregister_db_env.html" title="register_db_env" /> 12 <link rel="next" href="stldbstl_global_functionsopen_env.html" title="open_env" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center"> 19open_db 20</th> 21 </tr> 22 <tr> 23 <td width="20%" align="left"><a accesskey="p" href="stldbstl_global_functionsregister_db_env.html">Prev</a> </td> 24 <th width="60%" align="center">Chapter 1. 25 Dbstl Global Public Functions </th> 26 <td width="20%" align="right"> <a accesskey="n" href="stldbstl_global_functionsopen_env.html">Next</a></td> 27 </tr> 28 </table> 29 <hr /> 30 </div> 31 <div class="sect1" lang="en" xml:lang="en"> 32 <div class="titlepage"> 33 <div> 34 <div> 35 <h2 class="title" style="clear: both"><a id="stldbstl_global_functionsopen_db"></a> 36open_db 37</h2> 38 </div> 39 </div> 40 </div> 41 <div class="sect2" lang="en" xml:lang="en"> 42 <div class="titlepage"> 43 <div> 44 <div> 45 <h3 class="title"><a id="func_details"></a> 46Function Details</h3> 47 </div> 48 </div> 49 </div> 50 <pre class="programlisting"> 51 Db* open_db(DbEnv *penv, const char *filename, DBTYPE dbtype, 52 u_int32_t oflags, u_int32_t set_flags, int mode=0644, DbTxn *txn=NULL, 53 u_int32_t cflags=0, 54 const char *dbname=NULL) 55 </pre> 56 <div class="sect3" lang="en" xml:lang="en"> 57 <div class="titlepage"></div> 58 <p>Helper function to open a database and register it into dbstl for the calling thread. </p> 59 <p>Users still need to register it in any other thread using it if it is shared by multiple threads, via <a class="link" href="stldbstl_global_functionsregister_db.html" title="register_db">register_db()</a> 60 function. Users don't need to delete or free the memory of the returned object, dbstl will take care of that. When you don't use <a class="link" href="stldbstl_global_functionsopen_db.html" title="open_db">dbstl::open_db()</a> 61 but explicitly call DB C++ API to open a database, you must new the Db object, rather than create it on stack, and you must delete the Db object by yourself. </p> 62 </div> 63 <div class="sect3" lang="en" xml:lang="en"> 64 <div class="titlepage"> 65 <div> 66 <div> 67 <h4 class="title"><a id="id1542946"></a> 68Parameters</h4> 69 </div> 70 </div> 71 </div> 72 <div class="sect4" lang="en" xml:lang="en"> 73 <div class="titlepage"> 74 <div> 75 <div> 76 <h5 class="title"><a id="id1542748"></a> 77 penv </h5> 78 </div> 79 </div> 80 </div> 81 <p>The environment to open the database from. </p> 82 </div> 83 <div class="sect4" lang="en" xml:lang="en"> 84 <div class="titlepage"> 85 <div> 86 <div> 87 <h5 class="title"><a id="id1543077"></a> 88 txn </h5> 89 </div> 90 </div> 91 </div> 92 <p>The transaction to open the database from, passed to Db::open. </p> 93 </div> 94 <div class="sect4" lang="en" xml:lang="en"> 95 <div class="titlepage"> 96 <div> 97 <div> 98 <h5 class="title"><a id="id1542870"></a> 99 dbtype </h5> 100 </div> 101 </div> 102 </div> 103 <p>The database type, passed to Db::open. </p> 104 </div> 105 <div class="sect4" lang="en" xml:lang="en"> 106 <div class="titlepage"> 107 <div> 108 <div> 109 <h5 class="title"><a id="id1542746"></a> 110 oflags </h5> 111 </div> 112 </div> 113 </div> 114 <p>The database open flags, passed to Db::open. </p> 115 </div> 116 <div class="sect4" lang="en" xml:lang="en"> 117 <div class="titlepage"> 118 <div> 119 <div> 120 <h5 class="title"><a id="id1543072"></a> 121 filename </h5> 122 </div> 123 </div> 124 </div> 125 <p>The database file name, passed to Db::open. </p> 126 </div> 127 <div class="sect4" lang="en" xml:lang="en"> 128 <div class="titlepage"> 129 <div> 130 <div> 131 <h5 class="title"><a id="id1543151"></a> 132 mode </h5> 133 </div> 134 </div> 135 </div> 136 <p>The database open mode, passed to Db::open. </p> 137 </div> 138 <div class="sect4" lang="en" xml:lang="en"> 139 <div class="titlepage"> 140 <div> 141 <div> 142 <h5 class="title"><a id="id1542621"></a> 143 cflags </h5> 144 </div> 145 </div> 146 </div> 147 <p>The create flags passed to Db class constructor. </p> 148 </div> 149 <div class="sect4" lang="en" xml:lang="en"> 150 <div class="titlepage"> 151 <div> 152 <div> 153 <h5 class="title"><a id="id1543074"></a> 154 dbname </h5> 155 </div> 156 </div> 157 </div> 158 <p>The database name, passed to Db::open. </p> 159 </div> 160 <div class="sect4" lang="en" xml:lang="en"> 161 <div class="titlepage"> 162 <div> 163 <div> 164 <h5 class="title"><a id="id1542783"></a> 165 set_flags </h5> 166 </div> 167 </div> 168 </div> 169 <p>The flags to be set to the created database handle. </p> 170 </div> 171 </div> 172 <div class="sect3" lang="en" xml:lang="en"> 173 <div class="titlepage"> 174 <div> 175 <div> 176 <h4 class="title"><a id="id1543148"></a> 177Return Value</h4> 178 </div> 179 </div> 180 </div> 181 <p>The opened database handle. </p> 182 </div> 183 <div class="sect3" lang="en" xml:lang="en"> 184 <div class="titlepage"> 185 <div> 186 <div> 187 <h4 class="title"><a id="id1543107"></a> 188See Also</h4> 189 </div> 190 </div> 191 </div> 192 <p> 193 </p> 194 <p><a class="link" href="stldbstl_global_functionsregister_db.html" title="register_db">register_db(Db *)</a> 195; </p> 196 <p>open_db_env; </p> 197 <p> </p> 198 </div> 199 </div> 200 <div class="sect2" lang="en" xml:lang="en"> 201 <div class="titlepage"> 202 <div> 203 <div> 204 <h3 class="title"><a id="id1542747"></a> 205Class</h3> 206 </div> 207 </div> 208 </div> 209 <p> 210 <a class="link" href="dbstl_global_functions.html" title="Chapter 1. Dbstl Global Public Functions"> 211 dbstl_global_functions</a> 212 </p> 213 </div> 214 </div> 215 <div class="navfooter"> 216 <hr /> 217 <table width="100%" summary="Navigation footer"> 218 <tr> 219 <td width="40%" align="left"><a accesskey="p" href="stldbstl_global_functionsregister_db_env.html">Prev</a> </td> 220 <td width="20%" align="center"> 221 <a accesskey="u" href="dbstl_global_functions.html">Up</a> 222 </td> 223 <td width="40%" align="right"> <a accesskey="n" href="stldbstl_global_functionsopen_env.html">Next</a></td> 224 </tr> 225 <tr> 226 <td width="40%" align="left" valign="top"> 227register_db_env 228 </td> 229 <td width="20%" align="center"> 230 <a accesskey="h" href="index.html">Home</a> 231 </td> 232 <td width="40%" align="right" valign="top"> 233open_env 234</td> 235 </tr> 236 </table> 237 </div> 238 </body> 239</html> 240