std::basic_istream<CharT,Traits>::getline

basic_istream& getline( char_type* s, std::streamsize count );

basic_istream& getline( char_type* s, std::streamsize count, char_type delim );

Извлекает символы из потока до конца строки или указанного разделителя delim.

Первый перегруз равен getline(s, count, widen('\n')).

Ведёт себя как UnformattedInputFunction. После построения и проверки объекта sentry, извлекает символы из *this и сохраняет их в последовательных позициях массива, начало которого указано в s, до тех пор, пока не произойдёт одно из следующих событий (проверяется в указанном порядке):

1. В последовательности входных данных возникает состояние конца файла.
2. Следующий доступный символ c является разделителем, как определяется Traits::eq(c, delim). Разделитель извлекается (в отличие от basic_istream::get()) и учитывается в gcount(), но не сохраняется.
3. count не положительно, или count - 1 символов было извлечено (setstate(failbit) вызывается в этом случае).

Если функция не извлекает ни одного символа, то ​failbit устанавливается в локальном состоянии ошибки перед вызовом setstate().

В любом случае, если count > 0, то затем сохраняет нулевой символ CharT() в следующую последовательную позицию массива и обновляет gcount().

Примечания

Поскольку условие #2 проверяется перед условием #3, входная строка, которая точно подходит к буферу, не вызывает failbit.

Поскольку завершающий символ учитывается как извлечённый символ, пустая входная строка не вызывает failbit.

Параметры

Возвращаемое значение

*this

Исключения

Если внутренняя операция вызывает исключение, оно перехватывается, и badbit устанавливается. Если exceptions() установлено для badbit, исключение повторно выбрасывается.

Пример

#include <array>
#include <iostream>
#include <sstream>
#include <vector>
 
int main()
{
    std::istringstream input("abc|def|gh");
    std::vector<std::array<char, 4>> v;
 
    // note: the following loop terminates when std::ios_base::operator bool()
    // on the stream returned from getline() returns false
    for (std::array<char, 4> a; input.getline(&a[0], 4, '|');)
        v.push_back(a);
 
    for (auto& a : v)
        std::cout << &a[0] << '\n';
}

abc
def
gh

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

См. также