std::basic_istream::getline
| basic_istream& getline( char_type* s, std::streamsize count ); |
(1) | |
| basic_istream& getline( char_type* s, std::streamsize count, char_type delim ); |
(2) | |
1) Extracts characters from stream until the end of line (equivalent to getline(s, count, widen(’\n’)))
2) Extracts characters from stream until the specified delimiter.
First, constructs a std::basic_istream::sentry object with noskipws set to true. Afterwards, if good()==false, calls setstate(failbit) and returns. Otherwise, extracts characters from the stream and stores them in successive positions of the character array whose first element is pointed to by s.
Characters are extracted and stored until any of the following occurs, tested in the order shown:
- end of file condition occurs in the input sequence (in which case setstate(eofbit) is executed)
- the next available character c is the delimiter, as determined by Traits::eq(c, delim). The delimiter is extracted (unlike basic_istream::get()) and counted towards gcount(), but is not stored.
- count-1 characters have been extracted (in which case setstate(failbit) is executed).
If the function extracts no characters (e.g. if count < 1), setstate(failbit) is executed.
In any case, if count>0, it then stores a null character CharT() into the next successive location of the array and updates gcount().
Contents |
[edit] Notes
Because condition #2 is tested before condition #3, the input line that exactly fits the buffer, does not trigger failbit.
Because the terminating character is counted as extracted character, empty input line does not trigger failbit.
[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
#include <iostream> #include <sstream> #include <vector> #include <array> int main() { std::istringstream input("abc|def|gh"); std::vector<std::array<char, 4>> v; for(std::array<char, 4> a; input.getline(&a[0], 4, '|'); ) v.push_back(a); for(auto& a : v) std::cout << &a[0] << '\n'; }
Output:
abc def gh
[edit] See also
| read data from an I/O stream into a string (function) | |
| extracts formatted data (public member function) | |
| extracts characters (public member function) | |
| extracts blocks of characters (public member function) | |
