std::basic_string::erase

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Strings library

Null-terminated strings

Byte strings

Multibyte strings

Wide strings

Classes

basic_string

char_traits

 

std::basic_string

Member functions basic_string::basic_string basic_string::operator= basic_string::assign basic_string::get_allocator Element access basic_string::at basic_string::operator[] basic_string::front (C++11) basic_string::back (C++11) basic_string::data basic_string::c_str Iterators basic_string::beginbasic_string::cbegin (C++11) basic_string::endbasic_string::cend (C++11) basic_string::rbeginbasic_string::crbegin (C++11) basic_string::rendbasic_string::crend (C++11) Capacity basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (C++11)

Operations basic_string::clear basic_string::insert basic_string::erase basic_string::push_back basic_string::pop_back (C++11) basic_string::append basic_string::operator+= basic_string::compare basic_string::replace basic_string::substr basic_string::copy basic_string::resize basic_string::swap Search basic_string::find basic_string::rfind basic_string::find_first_of basic_string::find_first_not_of basic_string::find_last_of basic_string::find_last_not_of Constants basic_string::npos

Non-member functions operator+ operator==operator!=operator<operator>operator<=operator>= swap(std::basic_string) operator<<operator>> getline stoistolstoll (C++11)(C++11)(C++11) stoulstoull (C++11)(C++11) stofstodstold (C++11)(C++11)(C++11) to_string (C++11) to_wstring (C++11) Helper classes hash<std::string>hash<std::wstring>hash<std::u32string>hash<std::u16string> (C++11)

 

basic_string& erase( size_type index = 0, size_type count = npos );	(1)
	(2)
iterator erase( iterator position );			(until C++11)
iterator erase( const_iterator position );			(since C++11)
		(3)
iterator erase( iterator first, iterator last );				(until C++11)
iterator erase( const_iterator first, const_iterator last );				(since C++11)

Removes specified characters from the string.

1) Removes min(count, size() - index) characters starting at index.

2) Removes the character at position.

3) Removes the character in the range [first; last).

Parameters

index	-	first character to remove
count	-	number of characters to remove
position	-	iterator to the character to remove
first, last	-	range of the characters to remove

Return value

1) *this

2-3) iterator following the last removed character.

Exceptions

1) std::out_of_range if index > size().

2-3) (none)

In any case, if an exception is thrown for any reason, this function has no effect (strong exception guarantee). (since C++11)

Example

Run this code

#include <iostream>
#include <algorithm>
#include <string>
int main ()
{
    std::string s = "This is an example";
    std::cout << s << '\n';
 
    s.erase(0, 5); // Erase "This "
    std::cout << s << '\n';
 
    s.erase(std::find(s.begin(), s.end(), ' ')); // Erase ' '
    std::cout << s << '\n';
 
    s.erase(s.find(' ')); // Trim from ' ' to the end of the string
    std::cout << s << '\n';
}

Output:

This is an example
is an example
isan example
isan

See also

clear

clears the contents (public member function)