libdb/docs/api_reference/STL/stldb_maprbegin.html

251 lines
9.2 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>rbegin</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="db_map.html" title="Chapter 5.  Db_map" />
<link rel="prev" href="stldb_mapend.html" title="end" />
<link rel="next" href="stldb_maprend.html" title="rend" />
</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">rbegin</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldb_mapend.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
Db_map </th>
<td width="20%" align="right"> <a accesskey="n" href="stldb_maprend.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="stldb_maprbegin"></a>rbegin</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldb_maprbegin_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
reverse_iterator rbegin(ReadModifyWriteOption rmw=
ReadModifyWriteOption::no_read_modify_write(), bool read_only=false,
BulkRetrievalOption bulkretrieval=
BulkRetrievalOption::no_bulk_retrieval(),
bool directdb_get=true)
</pre>
<p>Begin a read-write or readonly reverse iterator which sits on the first key/data pair of the database. </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="id3601940"></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="id3601900"></a>directdb_get</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </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="id3602004"></a>read_only</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </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="id3602011"></a>rmw</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </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="id3602018"></a>bulkretrieval</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p>
</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="id3601969"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The created iterator. </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="id3601966"></a>See Also</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
</p>
<p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a>
(<a class="link" href="ReadModifyWriteOption.html" title="Chapter 28.  ReadModifyWriteOption">ReadModifyWriteOption</a>
, bool, <a class="link" href="BulkRetrievalOption.html" title="Chapter 27.  BulkRetrievalOption">BulkRetrievalOption</a>
, bool) </p>
<p>
</p>
<p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a>
(ReadModifyWrite, bool, <a class="link" href="BulkRetrievalOption.html" title="Chapter 27.  BulkRetrievalOption">BulkRetrievalOption</a>
, bool); </p>
<p>
</p>
</div>
<pre class="programlisting">
const_reverse_iterator rbegin(BulkRetrievalOption bulkretrieval=
BulkRetrievalOption::no_bulk_retrieval(),
bool directdb_get=true) const
</pre>
<p>Begin a read-only reverse iterator. </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="id3601797"></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="id3601626"></a>directdb_get</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </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="id3601883"></a>bulkretrieval</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>Same as that of begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p>
</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="id3601888"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The created const iterator. </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="id3601894"></a>See Also</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
</p>
<p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a>
(ReadModifyWrite, bool, <a class="link" href="BulkRetrievalOption.html" title="Chapter 27.  BulkRetrievalOption">BulkRetrievalOption</a>
, bool); </p>
<p>
</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="id3601623"></a>Group: Iterator Functions</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The parameters in begin functions of this group have identical meaning to thoes in <a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a>
, refer to those functions for details.</p>
<div class="simplesect" lang="en" xml:lang="en">
<div class="titlepage"></div>
<p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::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="id3602066"></a>Class</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="stldb_mapend.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db_map.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="stldb_maprend.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">end </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> rend</td>
</tr>
</table>
</div>
</body>
</html>