docs/api_reference/C/dbget_re_len.html

   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-&gt;get_re_len()</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_delim.html" title="DB-&gt;get_re_delim()" />
  12     <link rel="next" href="dbget_re_pad.html" title="DB-&gt;get_re_pad()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">DB-&gt;get_re_len()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="dbget_re_delim.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 2.
  26                 The DB Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="dbget_re_pad.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="dbget_re_len"></a>DB-&gt;get_re_len()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db.h&gt;
  42
  43 int
  44 DB-&gt;get_re_len(DB *db, u_int32_t *re_lenp);  </pre>
  45       <p>
  46         The <code class="methodname">DB-&gt;get_re_len()</code> method returns the length of the records held
  47         in a Queue access method database. This value can be set using the
  48         <a class="xref" href="dbset_re_len.html" title="DB-&gt;set_re_len()">DB-&gt;set_re_len()</a>
  49         method.
  50     </p>
  51       <p>
  52          The <code class="methodname">DB-&gt;get_re_len()</code> method may be
  53          called only after the database has been opened.
  54     </p>
  55       <p>
  56          The <code class="methodname">DB-&gt;get_re_len()</code> <span>
  57             <span>
  58                   method returns a non-zero error value on failure and 0 on success.
  59             </span>
  60
  61         </span>
  62     </p>
  63       <div class="sect2" lang="en" xml:lang="en">
  64         <div class="titlepage">
  65           <div>
  66             <div>
  67               <h3 class="title"><a id="idp57777992"></a>Parameters</h3>
  68             </div>
  69           </div>
  70         </div>
  71         <div class="sect3" lang="en" xml:lang="en">
  72           <div class="titlepage">
  73             <div>
  74               <div>
  75                 <h4 class="title"><a id="idp57777344"></a>re_lenp</h4>
  76               </div>
  77             </div>
  78           </div>
  79           <p>
  80                           The <code class="methodname">DB-&gt;get_re_len()</code> method returns  the record
  81                           length in <span class="bold"><strong>re_lenp</strong></span>. If the record length
  82                           has never been set using
  83                           <a class="xref" href="dbset_re_len.html" title="DB-&gt;set_re_len()">DB-&gt;set_re_len()</a>,
  84                           then <code class="literal">0</code> is returned.
  85                      </p>
  86         </div>
  87       </div>
  88       <div class="sect2" lang="en" xml:lang="en">
  89         <div class="titlepage">
  90           <div>
  91             <div>
  92               <h3 class="title"><a id="idp57737592"></a>Class</h3>
  93             </div>
  94           </div>
  95         </div>
  96         <p>
  97                 <a class="link" href="db.html" title="Chapter 2.  The DB Handle">DB</a>
  98             </p>
  99       </div>
 100       <div class="sect2" lang="en" xml:lang="en">
 101         <div class="titlepage">
 102           <div>
 103             <div>
 104               <h3 class="title"><a id="idp57778856"></a>See Also</h3>
 105             </div>
 106           </div>
 107         </div>
 108         <p>
 109                     <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
 110                     <a class="xref" href="dbset_re_len.html" title="DB-&gt;set_re_len()">DB-&gt;set_re_len()</a>
 111                 </p>
 112       </div>
 113     </div>
 114     <div class="navfooter">
 115       <hr />
 116       <table width="100%" summary="Navigation footer">
 117         <tr>
 118           <td width="40%" align="left"><a accesskey="p" href="dbget_re_delim.html">Prev</a> </td>
 119           <td width="20%" align="center">
 120             <a accesskey="u" href="db.html">Up</a>
 121           </td>
 122           <td width="40%" align="right"> <a accesskey="n" href="dbget_re_pad.html">Next</a></td>
 123         </tr>
 124         <tr>
 125           <td width="40%" align="left" valign="top">DB-&gt;get_re_delim() </td>
 126           <td width="20%" align="center">
 127             <a accesskey="h" href="index.html">Home</a>
 128           </td>
 129           <td width="40%" align="right" valign="top"> DB-&gt;get_re_pad()</td>
 130         </tr>
 131       </table>
 132     </div>
 133   </body>
 134 </html>