1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::erase (1 of 3 overloads)</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Boost.StaticString"> 8<link rel="up" href="../erase.html" title="basic_static_string::erase"> 9<link rel="prev" href="../erase.html" title="basic_static_string::erase"> 10<link rel="next" href="overload2.html" title="basic_static_string::erase (2 of 3 overloads)"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../erase.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1"></a><a class="link" href="overload1.html" title="basic_static_string::erase (1 of 3 overloads)">basic_static_string::erase 28 (1 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Erase from the string. 32 </p> 33<h6> 34<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h0"></a> 35 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.synopsis"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.synopsis">Synopsis</a> 36 </h6> 37<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">basic_static_string</span><span class="special">&</span> 38<span class="identifier">erase</span><span class="special">(</span> 39 <span class="identifier">size_type</span> <span class="identifier">index</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 40 <span class="identifier">size_type</span> <span class="identifier">count</span> <span class="special">=</span> <a class="link" href="../npos.html" title="basic_static_string::npos">npos</a><span class="special">);</span> 41</pre> 42<h6> 43<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h1"></a> 44 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.description"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.description">Description</a> 45 </h6> 46<p> 47 Erases <code class="computeroutput"><span class="identifier">num</span></code> characters 48 from the string, starting at <code class="computeroutput"><span class="identifier">index</span></code>. 49 <code class="computeroutput"><span class="identifier">num</span></code> is determined as 50 the smaller of <code class="computeroutput"><span class="identifier">count</span></code> 51 and <a class="link" href="../size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 52 - index. 53 </p> 54<h6> 55<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h2"></a> 56 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.exception_safety"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.exception_safety">Exception 57 Safety</a> 58 </h6> 59<p> 60 Strong guarantee. 61 </p> 62<h6> 63<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h3"></a> 64 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.remarks"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.remarks">Remarks</a> 65 </h6> 66<p> 67 All references, pointers, or iterators referring to contained elements 68 are invalidated. Any past-the-end iterators are also invalidated. 69 </p> 70<h6> 71<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h4"></a> 72 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.return_value"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.return_value">Return 73 Value</a> 74 </h6> 75<p> 76 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> 77 </p> 78<h6> 79<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h5"></a> 80 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.parameters"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.parameters">Parameters</a> 81 </h6> 82<div class="informaltable"><table class="table"> 83<colgroup> 84<col> 85<col> 86</colgroup> 87<thead><tr> 88<th> 89 <p> 90 Name 91 </p> 92 </th> 93<th> 94 <p> 95 Description 96 </p> 97 </th> 98</tr></thead> 99<tbody> 100<tr> 101<td> 102 <p> 103 <code class="computeroutput"><span class="identifier">index</span></code> 104 </p> 105 </td> 106<td> 107 <p> 108 The index to erase at. The default argument for this parameter 109 is <code class="computeroutput"><span class="number">0</span></code>. 110 </p> 111 </td> 112</tr> 113<tr> 114<td> 115 <p> 116 <code class="computeroutput"><span class="identifier">count</span></code> 117 </p> 118 </td> 119<td> 120 <p> 121 The number of characters to erase. The default argument for 122 this parameter is <a class="link" href="../npos.html" title="basic_static_string::npos"><code class="computeroutput"><span class="identifier">npos</span></code></a>. 123 </p> 124 </td> 125</tr> 126</tbody> 127</table></div> 128<h6> 129<a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.h6"></a> 130 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.erase.overload1.exceptions"></a></span><a class="link" href="overload1.html#static_string.ref.boost__static_strings__basic_static_string.erase.overload1.exceptions">Exceptions</a> 131 </h6> 132<div class="informaltable"><table class="table"> 133<colgroup> 134<col> 135<col> 136</colgroup> 137<thead><tr> 138<th> 139 <p> 140 Type 141 </p> 142 </th> 143<th> 144 <p> 145 Thrown On 146 </p> 147 </th> 148</tr></thead> 149<tbody><tr> 150<td> 151 <p> 152 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code> 153 </p> 154 </td> 155<td> 156 <p> 157 index > <a class="link" href="../size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 158 </p> 159 </td> 160</tr></tbody> 161</table></div> 162</div> 163<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 164<td align="left"></td> 165<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 166 Falco<p> 167 Distributed under the Boost Software License, Version 1.0. (See accompanying 168 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 169 </p> 170</div></td> 171</tr></table> 172<hr> 173<div class="spirit-nav"> 174<a accesskey="p" href="../erase.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../erase.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 175</div> 176</body> 177</html> 178
