greg/libdb
1
0
Fork 0
mirror of https://github.com/berkeleydb/libdb.git synced 2024-11-17 01:26:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
libdb/docs/api_reference/STL/stldb_mapbegin.html
Gregory Burd eff277ac23 Release 5.2.28 on 6/10/2011
2011-09-13 13:44:24 -04:00

249 lines
8.9 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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>begin</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_mapinsert.html" title="insert" />
<link rel="next" href="stldb_mapend.html" title="end" />
</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">
begin
</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldb_mapinsert.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
Db_map </th>
<td width="20%" align="right"> <a accesskey="n" href="stldb_mapend.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_mapbegin"></a>
begin
</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldb_mapbegin_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
iterator begin(ReadModifyWriteOption rmw=
ReadModifyWriteOption::no_read_modify_write(), bool readonly=false,
BulkRetrievalOption bulkretrieval=
BulkRetrievalOption::no_bulk_retrieval(),
bool directdb_get=true)
</pre>
<p>Begin a read-write or readonly 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>
<h4 class="title"><a id="id3521299"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="id3521362"></a>directdb_get</h5>
</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>
<h5 class="title"><a id="id3521566"></a>readonly</h5>
</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>
<h5 class="title"><a id="id3521573"></a>rmw</h5>
</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>
<h5 class="title"><a id="id3521580"></a>bulkretrieval</h5>
</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>
<h4 class="title"><a id="id3521527"></a>Return Value</h4>
</div>
</div>
</div>
<p>The created iterator. </p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3521586"></a>See Also</h4>
</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>
</div>
<pre class="programlisting">
const_iterator begin(BulkRetrievalOption bulkretrieval=
BulkRetrievalOption::no_bulk_retrieval(),
bool directdb_get=true) const
</pre>
<p>Begin a read-only iterator. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3521286"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="id3521391"></a>directdb_get</h5>
</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>
<h5 class="title"><a id="id3521345"></a>bulkretrieval</h5>
</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>
<h4 class="title"><a id="id3521350"></a>Return Value</h4>
</div>
</div>
</div>
<p>The created const iterator. </p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3521356"></a>See Also</h4>
</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>
<h3 class="title"><a id="id3521332"></a>Group: Iterator Functions</h3>
</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>
<h3 class="title"><a id="id3521630"></a>Class</h3>
</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_mapinsert.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_mapend.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">insert </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> end</td>
</tr>
</table>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink