libdb/docs/api_reference/C/db_heap_rid.html

135 lines
4.6 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB_HEAP_RID</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="db.html" title="Chapter 2.  The DB Handle" />
<link rel="prev" href="dbverify.html" title="DB-&gt;verify()" />
<link rel="next" href="dbc.html" title="Chapter 3.  The DBcursor Handle" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_HEAP_RID</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbverify.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. 
The DB Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbc.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="db_heap_rid"></a>DB_HEAP_RID</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
struct __db_heap_rid {
db_pgno_t pgno; /* Page number. */
db_indx_t indx; /* Index in the offset table. */
}; </pre>
<p>
Content used for the key in a Heap database record. Berkeley DB
<span>creates this structure</span>
for you when you create a record in a Heap database. You should
never
<span>create this structure or modify the contents
of this structure </span>
yourself; Berkeley DB must create and manage it for you.
</p>
<p>
This
<span>structure</span>
is returned in the <span class="bold"><strong>key</strong></span>
DBT parameter of the method that you use to add a record to the
Heap database.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3695694"></a>Parameters</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3695232"></a>pgno</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
The database page number where the record is stored.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3695999"></a>indx</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
Index in the offset table where the record can be found.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3695647"></a>See Also</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbverify.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbc.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB-&gt;verify() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Chapter 3. 
The DBcursor Handle
</td>
</tr>
</table>
</div>
</body>
</html>