db_get_type.html   [plain text]


<!--$Id: db_get_type.so,v 10.28 2007/09/21 20:06:01 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::get_type</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>
<b>Db::get_type</b>
</td>
<td align=right>
<a href="../api_cxx/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>
<b><pre>
#include &lt;db_cxx.h&gt;
<p>
int
Db::get_type(DBTYPE *type);
</pre></b>
<hr size=1 noshade>
<b>Description: Db::get_type</b>
<p>The Db::get_type method returns the type of the underlying access
method (and file format).  The type value is one of DB_BTREE, DB_HASH,
DB_RECNO, or DB_QUEUE.  This value may be used to determine the type of
the database after a return from <a href="../api_cxx/db_open.html">Db::open</a> with the <b>type</b>
parameter set to DB_UNKNOWN.</p>
<p>The Db::get_type method may not be called before the <a href="../api_cxx/db_open.html">Db::open</a> method is called.</p>
<p>The Db::get_type method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</p>
<b>Parameters</b> <br>
 <b>type</b><ul compact><li>The <b>type</b> parameter references memory into which
 the type of the underlying access method is copied.</ul> 
<br>
<br><b>Errors</b>
<p>The Db::get_type method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<br>
<b>EINVAL</b><ul compact><li>If the method was called before <a href="../api_cxx/db_open.html">Db::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/db_class.html">Db</a>
<br><b>See Also</b>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/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>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>