libdb/docs/api_reference/STL/db_map_iterator.html

308 lines
11 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>Chapter 16.  Db_map_iterator</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++ Standard Template Library API Reference" />
<link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
<link rel="prev" href="stldb_map_base_iteratoroperator_assign.html" title="operator=" />
<link rel="next" href="stldb_map_iteratordstr_db_map_iterator.html" title="~db_map_iterator" />
</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">Chapter 16. 
Db_map_iterator </th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldb_map_base_iteratoroperator_assign.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="stldb_map_iteratordstr_db_map_iterator.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="chapter" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="db_map_iterator"></a>Chapter 16. 
Db_map_iterator </h2>
</div>
</div>
</div>
2011-12-20 00:07:10 +00:00
<h4><a id="id3614183"></a> Public Members </h4>
2011-09-13 17:44:24 +00:00
<div class="informaltable">
<table border="1" width="80%">
<colgroup>
<col />
<col />
</colgroup>
<thead>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="db_map_iterator.html#stldb_map_iteratordb_map_iterator" title="db_map_iterator">db_map_iterator</a>
</td>
<td>
<p>Copy constructor. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratordstr_db_map_iterator.html" title="~db_map_iterator">~db_map_iterator</a>
</td>
<td>
<p>Destructor. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratoroperator_incr.html" title="operator++">operator++</a>
</td>
<td>
<p>Pre-increment. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratoroperator_decr.html" title="operator--">operator--</a>
</td>
<td>
<p>Pre-decrement. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratoroperator__star.html" title="operator *">operator *</a>
</td>
<td>
<p>Dereference operator. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratoroperator_arrow.html" title="operator-&gt;">operator-&gt;</a>
</td>
<td>
<p>Arrow operator. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratorrefresh.html" title="refresh">refresh</a>
</td>
<td>
<p>Refresh iterator cached value. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stldb_map_iteratoroperator_assign.html" title="operator=">operator=</a>
</td>
<td>
<p>Assignment operator. </p> </td>
</tr>
</tbody>
</table>
</div>
2011-12-20 00:07:10 +00:00
<h4><a id="id3614486"></a>
2011-09-13 17:44:24 +00:00
Group</h4>
<p>
<a class="xref" href="dbstl_iterators.html" title="Chapter 9.  Dbstl Iterator Classes">
Dbstl Iterator Classes </a>
</p>
<p>
</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="stldb_map_iteratordb_map_iterator"></a>db_map_iterator</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldb_map_iteratordb_map_iterator_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
db_map_iterator(const db_map_iterator&lt; kdt, ddt,
value_type_sub &gt; &amp;vi)
</pre>
<p>Copy constructor. </p>
<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="id3612885"></a>Parameters</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614413"></a>vi</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The other iterator of the same type to initialize this. </p>
</div>
</div>
<pre class="programlisting">
db_map_iterator(const db_map_base_iterator&lt; kdt, realddt,
ddt &gt; &amp;vi)
</pre>
<p>Base copy constructor. </p>
<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="id3614218"></a>Parameters</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614677"></a>vi</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Initialize from a base class iterator. </p>
</div>
</div>
<pre class="programlisting">
db_map_iterator(db_container *powner, u_int32_t b_bulk_retrieval=0,
bool brmw=false, bool directdbget=true,
bool b_read_only=false)
</pre>
<p>Constructor. </p>
<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="id3614691"></a>Parameters</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614694"></a>b_bulk_retrieval</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The bulk read buffer size. 0 means bulk read disabled. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614709"></a>brmw</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Whether set DB_RMW flag in underlying cursor. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614714"></a>powner</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The container which creates this iterator. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614720"></a>directdbget</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Whether do direct database get rather than using key/data values cached in the iterator whenever read. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3614727"></a>b_read_only</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Whether open a read only cursor. Only effective when using Berkeley DB Concurrent Data Store. </p>
</div>
</div>
<pre class="programlisting">
db_map_iterator()
</pre>
<p>Default constructor, dose not create the cursor for now. </p>
</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="id3614389"></a>Group: Constructors and destructor</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Do not create iterators directly using these constructors, but call <a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin</a>
or db_multimap_begin to get instances of this class.</p>
<div class="simplesect" lang="en" xml:lang="en">
<div class="titlepage"></div>
<p><a class="link" href="stldb_mapbegin.html" title="begin">db_map::begin()</a>
<a class="link" href="stldb_mapbegin.html" title="begin">db_multimap::begin()</a>
</p>
</div>
<p>
</p>
</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="id3614414"></a>Class</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="link" href="db_map_iterator.html" title="Chapter 16.  Db_map_iterator">db_map_iterator</a>
</p>
</div>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="stldb_map_base_iteratoroperator_assign.html">Prev</a> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href="stldb_map_iteratordstr_db_map_iterator.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">operator= </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> ~db_map_iterator</td>
</tr>
</table>
</div>
</body>
</html>