std::getline

 

C++

Language

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::begin basic_string::cbegin (C++11)

basic_string::end basic_string::cend (C++11)

basic_string::rbegin basic_string::crbegin (C++11)

basic_string::rend basic_string::crend (C++11)

Capacity

basic_string::empty

basic_string::size

basic_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

stoi stol stoll (C++11) (C++11) (C++11)

stoul stoull (C++11) (C++11)

stof stod stold (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)

 

Defined in header <string>
template< class CharT, class Traits, class Allocator > std::basic_istream<CharT,Traits>& getline( std::basic_istream<CharT,Traits>& input,                                            std::basic_string<CharT,Traits,Allocator>& str,                                            CharT delim );	(1)
template< class CharT, class Traits, class Allocator > std::basic_istream<CharT,Traits>& getline( std::basic_istream<CharT,Traits>&& input,                                            std::basic_string<CharT,Traits,Allocator>& str,                                            CharT delim );	(1)	(since C++11)
template< class CharT, class Traits, class Allocator > std::basic_istream<CharT,Traits>& getline( std::basic_istream<CharT,Traits>& input,                                            std::basic_string<CharT,Traits,Allocator>& str );	(2)
template< class CharT, class Traits, class Allocator > std::basic_istream<CharT,Traits>& getline( std::basic_istream<CharT,Traits>&& input,                                            std::basic_string<CharT,Traits,Allocator>& str );	(2)	(since C++11)

Reads in unformatted data from a stream into a string. Stops once a character equal to the delimiter is found, or the stream is exhausted. The first version uses delim as the delimiter, the second version uses '\n' as the delimiter. The delimiter character is discarded from the stream and not placed in the string.

Parameters

input	-	the stream to get data from
str	-	the string to put the data into
delim	-	the delimiter character

Return value

input

Example

The following code asks the user for their name, then greets them using that name.

#include <string>
#include <iostream>
 
int main()
{
    std::string name;
    std::cout << "What is your name? ";
    std::getline(std::cin, name);
    std::cout << "Hello " << name << ", nice to meet you.";
}

Output:

What is your name? John Q. Public
Hello John Q. Public, nice to meet you.