std::getline

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

文字列ライブラリ

クラス

basic_string

basic_string_view (C++17)

char_traits

 

std::basic_string

メンバ関数 basic_string::basic_string basic_string::~basic_string basic_string::operator= basic_string::assign basic_string::assign_range (C++23)   basic_string::get_allocator 要素アクセス basic_string::at basic_string::operator[] basic_string::front (DR*) basic_string::back (DR*) basic_string::data basic_string::c_str basic_string::operator  basic_string_view (C++17) イテレータ 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) 検索 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

変更 basic_string::clear basic_string::insert basic_string::insert_range (C++23) basic_string::erase basic_string::push_back basic_string::pop_back (DR*) basic_string::append basic_string::append_range (C++23) basic_string::operator+= basic_string::replace basic_string::replace_with_range (C++23) basic_string::copy basic_string::resize basic_string::resize_and_overwrite (C++23)  basic_string::swap 容量 basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (DR*) 操作 basic_string::compare basic_string::starts_with (C++20) basic_string::ends_with (C++20) basic_string::contains (C++23) basic_string::substr

定数 basic_string::npos 非メンバ関数 operator+ swap(std::basic_string) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) I/O operator<<operator>> getline 比較 operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20) 数値変換 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) リテラル operator""s (C++14) ヘルパークラス hash<std::basic_string> (C++11) 推論ガイド (C++17)

 

ヘッダ <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 );	(2)	(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 );	(3)
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 );	(4)	(C++11以降)

getline は入力ストリームから文字を読み取り、それらを文字列に配置します。

1,2) input.gcount() が影響を受けないことを除いて、UnformattedInputFunction と同様に動作します。センティネルオブジェクトを構築しチェックした後、以下を実行します。

1) str.erase() を呼び出します。

2) input から文字を抽出し、以下のいずれかが発生するまで (記載順にチェックされます)、それらを str に追加します。

a) input 上のファイル終端条件。この場合、getline は eofbit を設定します。

b) 次に利用可能な入力文字が delim である場合。Traits::eq(c, delim) によってテストされ、この場合、区切り文字は input から抽出されますが、str には追加されません。

c) str.max_size() 文字が格納された場合。この場合、getline は failbit を設定して戻ります。

3) 何らかの理由で文字が抽出されなかった場合 (破棄された区切り文字でさえも)、getline は failbit を設定して戻ります。

3,4) getline(input, str, input.widen('\n')) と同じです。つまり、デフォルトの区切り文字は改行文字です。

パラメータ

input	-	データを取得するストリーム
str	-	データを格納する文字列
delim	-	区切り文字

戻り値

input

注記

空白で区切られた入力 (例: int n; std::cin >> n;) を消費する場合、改行文字を含むそれに続く空白は入力ストリームに残ります。その後、行指向入力に切り替えると、getline で取得される最初の行は単なるその空白になります。これが望ましくない動作である可能性が高い場合、考えられる解決策は以下の通りです。

• getline への明示的な余分な最初の呼び出し。
• std::cin >> std::ws で連続する空白を削除する。
• cin.ignore(std::numeric_limits<std::streamsize>::max(), '\n'); で入力行の残りの文字をすべて無視する。

例

次の例は、getline 関数を使用してユーザー入力を読み取り、ストリームを1行ずつ、または delim パラメータを使用して行の一部を処理する方法を示しています。

このコードを実行

#include <iostream>
#include <sstream>
#include <string>
 
int main()
{
    // greet the user
    std::string name;
    std::cout << "What is your name? ";
    std::getline(std::cin, name);
    std::cout << "Hello " << name << ", nice to meet you.\n";
 
    // read file line by line
    std::istringstream input;
    input.str("1\n2\n3\n4\n5\n6\n7\n");
    int sum = 0;
    for (std::string line; std::getline(input, line);)
        sum += std::stoi(line);
    std::cout << "\nThe sum is " << sum << ".\n\n";
 
    // use separator to read parts of the line
    std::istringstream input2;
    input2.str("a;b;c;d");
    for (std::string line; std::getline(input2, line, ';');)
        std::cout << line << '\n';
}

実行結果の例

What is your name? John Q. Public
Hello John Q. Public, nice to meet you.
 
The sum is 28.
 
a
b
c
d

欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 91	C++98	getline は書式なし入力関数として動作しなかった。	書式なし入力関数として動作する。

関連項目

getline

指定された文字が見つかるまで文字を抽出する (std::basic_istream<CharT,Traits> の public メンバ関数)