std::basic_istream::getline

From Cppreference

C++ Standard Library
Language 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)
Input/output library
basic_streambuf basic_filebuf basic_stringbuf ios_base basic_ios basic_istream basic_ostream basic_iostream basic_ifstream basic_ofstream basic_fstream basic_istringstream basic_ostringstream basic_stringstream I/O manipulators C-style I/O
std::basic_istream
Member functions basic_istream::basic_istream basic_istream::~basic_istream Formatted input basic_istream::operator>> Unformatted input basic_istream::get basic_istream::peek basic_istream::unget basic_istream::putback basic_istream::getline basic_istream::ignore basic_istream::read basic_istream::readsome basic_istream::gcount Positioning basic_istream::tellg basic_istream::seekg Miscellaneous basic_istream::sync Member classes basic_istream::sentry

basic_istream& getline( char_type* s, pos_type count );	(1)
basic_istream& getline( char_type* s, pos_type count, char_type delim );	(2)

Extracts characters from stream. For both versions if good() != true, setstate(failbit) is called and the function returns. If end-of-file occurs, setstate(eofbit) is called and the function returns.

1) reads at most count-1 characters and stores them into character string pointed to by s. The function stops if \n delimiting character is found, in which case it is extracted but not stored. The resulting string is always null-terminated.

2) reads at most count-1 characters and stores them into character string pointed to by s. The function stops if delim delimiting character is found, in which case it is neither extracted nor stored. The resulting string is always null-terminated.

Contents 1 Parameters 2 Return value 3 Example 4 See also

[edit] Parameters

s	-	pointer to the character string to store the characters to
count	-	size of character string pointed to by s
delim	-	delimiting character to stop the extraction at. It is extracted but not stored.

[edit] Return value

*this

[edit] Example

This section is incomplete

[edit] See also

operator>>	extracts formatted data (public member function)
get	extracts characters (public member function)
read	extracts blocks of characters (public member function)