libdb/docs/api_reference/STL/stldb_mapinsert.html

253 lines
9 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>insert</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_mapdstr_db_map.html" title="~db_map" />
<link rel="next" href="stldb_mapbegin.html" title="begin" />
</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">insert</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldb_mapdstr_db_map.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
Db_map </th>
<td width="20%" align="right"> <a accesskey="n" href="stldb_mapbegin.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_mapinsert"></a>insert</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldb_mapinsert_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
insert(const value_type &amp;x)
</pre>
<p>Insert a single key/data pair if the key is not in the container. </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="id3601405"></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="id3601476"></a>x</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The key/data pair to insert. </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="id3601385"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>A pair P, if insert OK, i.e. the inserted key wasn't in the container, P.first will be the iterator sitting on the inserted key/data pair, and P.second is true; otherwise P.first is an invalid iterator and P.second is false. </p>
</div>
<pre class="programlisting">
iterator insert(iterator position,
const value_type &amp;x)
</pre>
<p>Insert with hint position. </p>
<p>We ignore the hint position because Berkeley DB knows better where to insert. </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="id3601519"></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="id3601522"></a>position</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The hint position. </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="id3601536"></a>x</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The key/data pair to insert. </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="id3601324"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The iterator sitting on the inserted key/data pair, or an invalid iterator if the key was already in the container. </p>
</div>
<pre class="programlisting">
void insert(const db_map_base_iterator&lt; kdt, realddt, ddt &gt; &amp;first,
const db_map_base_iterator&lt; kdt, realddt,
ddt &gt; &amp;last)
</pre>
<p>Range insertion. </p>
<p>Insert a range [first, last) of key/data pairs into this container. </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="id3601552"></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="id3601555"></a>last</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The open boundary of the range. </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="id3601569"></a>first</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The closed boundary of the range. </p>
</div>
</div>
<pre class="programlisting">
void insert(InputIterator first,
InputIterator last)
</pre>
<p>Range insertion. </p>
<p>Insert a range [first, last) of key/data pairs into this container. </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="id3601575"></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="id3601579"></a>last</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The open boundary of the range. </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="id3601593"></a>first</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The closed boundary of the range. </p>
</div>
</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="id3601282"></a>Group: Insert Functions</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>They have similiar usage as their C++ STL equivalents.</p>
<p>Note that when secondary index is enabled, each <a class="link" href="db_container.html" title="Chapter 3.  Db_container">db_container</a>
can create a <a class="link" href="db_multimap.html" title="Chapter 6.  Db_multimap">db_multimap</a>
secondary container, but the insert function is not functional for secondary containers. </p>
<div class="simplesect" lang="en" xml:lang="en">
<div class="titlepage"></div>
<p><a class="ulink" href="http://www.cplusplus.com/reference/stl/map/insert/" target="_top">http://www.cplusplus.com/reference/stl/map/insert/</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="id3601557"></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_mapdstr_db_map.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_mapbegin.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">~db_map </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> 
begin
</td>
</tr>
</table>
</div>
</body>
</html>