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>DB->get_type()</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 API Reference" /> 10 <link rel="up" href="db.html" title="Chapter 2. The DB Handle" /> 11 <link rel="prev" href="dbget_re_source.html" title="DB->get_re_source()" /> 12 <link rel="next" href="dbjoin.html" title="DB->join()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DB->get_type()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbget_re_source.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 2. 23 The DB Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="dbjoin.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="dbget_type"></a>DB->get_type()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41DB->get_type(DB *db, DBTYPE *type); </pre> 42 <p> 43 The <code class="methodname">DB->get_type()</code> method returns the type of the underlying access 44 method (and file format). The type value is one of DB_BTREE, DB_HASH, 45 DB_RECNO, or DB_QUEUE. This value may be used to determine the type 46 of the database after a return from <a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> 47 with the <span class="bold"><strong>type</strong></span> parameter set to DB_UNKNOWN. 48 </p> 49 <p> 50 The <code class="methodname">DB->get_type()</code> method may not be called before the 51 <a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> method is called. 52 </p> 53 <p> 54 The <code class="methodname">DB->get_type()</code> <span> 55 <span> 56 method returns a non-zero error value on failure and 0 on success. 57 </span> 58 59 </span> 60 </p> 61 <div class="sect2" lang="en" xml:lang="en"> 62 <div class="titlepage"> 63 <div> 64 <div> 65 <h3 class="title"><a id="id1638705"></a>Parameters</h3> 66 </div> 67 </div> 68 </div> 69 <div class="sect3" lang="en" xml:lang="en"> 70 <div class="titlepage"> 71 <div> 72 <div> 73 <h4 class="title"><a id="id1638622"></a>type</h4> 74 </div> 75 </div> 76 </div> 77 <p> 78 The <span class="bold"><strong>type</strong></span> parameter references memory 79 into which the type of the underlying access method is copied. 80 </p> 81 </div> 82 </div> 83 <div class="sect2" lang="en" xml:lang="en"> 84 <div class="titlepage"> 85 <div> 86 <div> 87 <h3 class="title"><a id="id1637944"></a>Errors</h3> 88 </div> 89 </div> 90 </div> 91 <p> 92 The <code class="methodname">DB->get_type()</code> <span> 93 <span> 94 method may fail and return one of the following non-zero errors: 95 </span> 96 97 </span> 98 </p> 99 <div class="sect3" lang="en" xml:lang="en"> 100 <div class="titlepage"> 101 <div> 102 <div> 103 <h4 class="title"><a id="id1638710"></a>EINVAL</h4> 104 </div> 105 </div> 106 </div> 107 <p> 108 If the method was called before <a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> 109 was called; or if an invalid flag value or parameter was specified. 110 </p> 111 </div> 112 </div> 113 <div class="sect2" lang="en" xml:lang="en"> 114 <div class="titlepage"> 115 <div> 116 <div> 117 <h3 class="title"><a id="id1637945"></a>Class</h3> 118 </div> 119 </div> 120 </div> 121 <p> 122 <a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a> 123 </p> 124 </div> 125 <div class="sect2" lang="en" xml:lang="en"> 126 <div class="titlepage"> 127 <div> 128 <div> 129 <h3 class="title"><a id="id1638722"></a>See Also</h3> 130 </div> 131 </div> 132 </div> 133 <p> 134 <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a> 135 </p> 136 </div> 137 </div> 138 <div class="navfooter"> 139 <hr /> 140 <table width="100%" summary="Navigation footer"> 141 <tr> 142 <td width="40%" align="left"><a accesskey="p" href="dbget_re_source.html">Prev</a> </td> 143 <td width="20%" align="center"> 144 <a accesskey="u" href="db.html">Up</a> 145 </td> 146 <td width="40%" align="right"> <a accesskey="n" href="dbjoin.html">Next</a></td> 147 </tr> 148 <tr> 149 <td width="40%" align="left" valign="top">DB->get_re_source() </td> 150 <td width="20%" align="center"> 151 <a accesskey="h" href="index.html">Home</a> 152 </td> 153 <td width="40%" align="right" valign="top"> DB->join()</td> 154 </tr> 155 </table> 156 </div> 157 </body> 158</html> 159