libdb/docs/api_reference/STL/stldb_maperase.html

190 lines
6.5 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>erase</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_mapempty.html" title="empty" />
<link rel="next" href="stldb_mapfind.html" title="find" />
</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">erase</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldb_mapempty.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5. 
Db_map </th>
<td width="20%" align="right"> <a accesskey="n" href="stldb_mapfind.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_maperase"></a>erase</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldb_maperase_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
void erase(iterator pos)
</pre>
<p>Erase a key/data pair at specified position. </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="id3602482"></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="id3602603"></a>pos</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>An valid iterator of this container to erase. </p>
</div>
</div>
<pre class="programlisting">
size_type erase(const key_type &amp;x)
</pre>
<p>Erase elements by key. </p>
<p>All key/data pairs with specified key x will be removed from underlying database. This function supports auto-commit. </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="id3602636"></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="id3602640"></a>x</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The key to remove from the container. </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="id3602562"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The number of key/data pairs removed. </p>
</div>
<pre class="programlisting">
void erase(iterator first,
iterator last)
</pre>
<p>Range erase. </p>
<p>Erase all key/data pairs within the valid range [first, last). </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="id3602659"></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="id3602662"></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="id3602676"></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="id3602499"></a>Group: Erase Functions</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="simplesect" lang="en" xml:lang="en">
<div class="titlepage"></div>
<p><a class="ulink" href="http://www.cplusplus.com/reference/stl/map/erase/" target="_top">http://www.cplusplus.com/reference/stl/map/erase/</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="id3602642"></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_mapempty.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_mapfind.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">empty </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> find</td>
</tr>
</table>
</div>
</body>
</html>