<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
erase [C++ Reference]
</title>
<meta name="generator" content="DokuWiki Release 2009-12-25c "Lemming"" />
<meta name="robots" content="index,follow" />
<meta name="date" content="2009-10-10T19:39:29-0700" />
<meta name="keywords" content="string,erase" />
<link rel="search" type="application/opensearchdescription+xml" href="/wiki/lib/exe/opensearch.php" title="C++ Reference" />
<link rel="start" href="/wiki/" />
<link rel="contents" href="/wiki/string/erase?do=index" title="Index" />
<link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/wiki/feed.php" />
<link rel="alternate" type="application/rss+xml" title="Current Namespace" href="/wiki/feed.php?mode=list&ns=string" />
<link rel="edit" title="Edit this page" href="/wiki/string/erase?do=edit" />
<link rel="alternate" type="text/html" title="Plain HTML" href="/wiki/_export/xhtml/string/erase" />
<link rel="alternate" type="text/plain" title="Wiki Markup" href="/wiki/_export/raw/string/erase" />
<link rel="stylesheet" media="all" type="text/css" href="/wiki/lib/exe/css.php?s=all&t=custom1&tseed=1272971091" />
<link rel="stylesheet" media="screen" type="text/css" href="/wiki/lib/exe/css.php?t=custom1&tseed=1272971091" />
<link rel="stylesheet" media="print" type="text/css" href="/wiki/lib/exe/css.php?s=print&t=custom1&tseed=1272971091" />
<script type="text/javascript" charset="utf-8" ><!--//--><![CDATA[//><!--
var NS='string';var JSINFO = {"id":"string:erase","namespace":"string"};
//--><!]]></script>
<script type="text/javascript" charset="utf-8" src="/wiki/lib/exe/js.php?tseed=1272971091" ></script>
<link rel="shortcut icon" href="/wiki/lib/tpl/custom1/images/favicon.png" />
</head>
<body>
<div class="dokuwiki">
<div class="stylehead">
<div class="breadcrumbs">
<span class="bchead">You are here: </span><a href="../start.html" title="start">C++ Reference</a> » <a href="../string/start.html" title="string:start">C++ Strings</a> » <a href="../string/erase.html" title="string:erase">erase</a> </div>
</div>
<div class="page">
</script>
<script type="text/javascript">
_uacct = "UA-2828341-1";
urchinTracker();
</script>
<!-- wikipage start -->
<h2><a name="erase" id="erase">erase</a></h2>
<div class="level2">
<p>
Syntax:
</p>
<pre class="c code c++" style="font-family:monospace;"> <span class="co2">#include <string></span>
iterator erase<span class="br0">(</span> iterator loc <span class="br0">)</span><span class="sy0">;</span>
iterator erase<span class="br0">(</span> iterator start<span class="sy0">,</span> iterator end <span class="br0">)</span><span class="sy0">;</span>
basic_string<span class="sy0">&</span> erase<span class="br0">(</span> size_type index <span class="sy0">=</span> 0<span class="sy0">,</span> size_type num <span class="sy0">=</span> npos <span class="br0">)</span><span class="sy0">;</span></pre>
<p>
The erase() function either:
</p>
<ul>
<li class="level1"><div class="li"> removes the character pointed to by <code>loc</code>, returning an iterator to the character after the last character removed</div>
</li>
<li class="level1"><div class="li"> removes all characters between <code>start</code> and <code>end</code>, returning an iterator to the next character (not the one at end)</div>
</li>
<li class="level1"><div class="li"> removes <code>num</code> characters starting from <code>index</code>, returning the modified string. The parameters <code>index</code> and <code>num</code> have default values, which means that erase() can be called with just <code>index</code> to erase all characters after <code>index</code> or with no arguments to erase all characters.</div>
</li>
</ul>
<p>
For example:
</p>
<pre class="c code c++" style="font-family:monospace;"> <span class="kw4">string</span> s<span class="br0">(</span><span class="st0">"So, you like donuts, eh? Well, have all the donuts in the world!"</span><span class="br0">)</span><span class="sy0">;</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"The original string is '"</span> <span class="sy0"><<</span> s <span class="sy0"><<</span> <span class="st0">"'"</span> <span class="sy0"><<</span> endl<span class="sy0">;</span>
s.<span class="me1">erase</span><span class="br0">(</span> 50<span class="sy0">,</span> 13 <span class="br0">)</span><span class="sy0">;</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"Now the string is '"</span> <span class="sy0"><<</span> s <span class="sy0"><<</span> <span class="st0">"'"</span> <span class="sy0"><<</span> endl<span class="sy0">;</span>
s.<span class="me1">erase</span><span class="br0">(</span> 24 <span class="br0">)</span><span class="sy0">;</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"Now the string is '"</span> <span class="sy0"><<</span> s <span class="sy0"><<</span> <span class="st0">"'"</span> <span class="sy0"><<</span> endl<span class="sy0">;</span>
s.<span class="me1">erase</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span>
<a href="http://www.opengroup.org/onlinepubs/009695399/functions/cout.html"><span class="kw3">cout</span></a> <span class="sy0"><<</span> <span class="st0">"Now the string is '"</span> <span class="sy0"><<</span> s <span class="sy0"><<</span> <span class="st0">"'"</span> <span class="sy0"><<</span> endl<span class="sy0">;</span></pre>
<p>
will display
</p>
<pre class="code">
The original string is 'So, you like donuts, eh? Well, have all the donuts in the world!'
Now the string is 'So, you like donuts, eh? Well, have all the donuts!'
Now the string is 'So, you like donuts, eh?'
Now the string is ''</pre>
<p>
erase() runs in <a href="../complexity.html" class="wikilink1" title="complexity">linear time</a>.
</p>
<p>
Related Topics: <a href="../string/insert.html" class="wikilink1" title="string:insert">insert</a>
</p>
</div>
<!-- wikipage stop -->
</div>
<div class="clearer"> </div>
<div class="stylefoot">
<div class="meta">
<div class="user">
</div>
<!--
<div class="doc">
string/erase.txt · Last modified: 10/10/2009 19:39 by 124.255.102.233 </div>
-->
</div>
</div></div></body>
</html>