std::fgets

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

入出力ライブラリ

I/Oマニピュレータ

出力関数 (C++23)

C形式I/O

バッファ

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

ストリーム

抽象化

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

ファイルI/O

basic_ifstream

basic_ofstream

basic_fstream

文字列I/O

basic_istringstream

basic_ostringstream

basic_stringstream

配列I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同期出力

basic_osyncstream (C++20)

型

streamoff

streamsize

fpos

エラーカテゴリインターフェース

iostream_category (C++11)

io_errc (C++11)

 

C形式I/O

型とオブジェクト
FILE fpos_t	stdinstdoutstderr
関数
ファイルアクセス fopen freopen fclose fflush fwide setbuf setvbuf 直接入出力 fread fwrite 非書式化入出力 fgetcgetc fgets fputcputc fputs getchar gets (C++14まで) putchar puts ungetc fgetwcgetwc fgetws fputwcputwc fputws getwchar putwchar ungetwc 書式付き入力 scanffscanfsscanf vscanfvfscanfvsscanf (C++11)(C++11)(C++11)     wscanffwscanfswscanf vwscanfvfwscanfvswscanf (C++11)(C++11)(C++11)	書式付き出力 printffprintfsprintfsnprintf (C++11) vprintfvfprintfvsprintfvsnprintf (C++11)     wprintffwprintfswprintf vwprintfvfwprintfvswprintf ファイルポジショニング ftell fgetpos fseek fsetpos rewind エラーハンドリング clearerr feof ferror perror ファイル操作 remove rename tmpfile tmpnam

 

ヘッダ<cstdio>で定義
char* fgets( char* str, int count, std::FILE* stream );

指定されたファイルストリームから最大 count - 1 文字を読み取り、str が指す文字配列に格納します。解析は、改行文字が見つかった場合（この場合、str にその改行文字が含まれます）、またはファイル終端に達した場合に停止します。バイトが読み取られ、エラーが発生しなかった場合、str に書き込まれた最後の文字の直後の位置にヌル文字を書き込みます。

パラメーター

str	-	文字配列の要素へのポインター
count	-	書き込む文字の最大数（通常は str の長さ）
stream	-	データを読み取るファイルストリーム

戻り値

成功した場合は str、失敗した場合はヌルポインター。

ファイル終端条件に遭遇した場合、stream の *eof* インジケーターを設定します (std::feof() を参照)。これは、バイトが読み取られない原因となった場合にのみ失敗と見なされ、その場合はヌルポインターが返され、str が指す配列の内容は変更されません（つまり、最初のバイトはヌル文字で上書きされません）。

失敗が他のエラーによって引き起こされた場合、stream の *error* インジケーターを設定します (std::ferror() を参照)。str が指す配列の内容は不定です（ヌル終端されていない可能性もあります）。

備考

POSIXはさらに、ファイル終端条件以外の失敗に遭遇した場合、fgets が errno を設定することを要求しています。

count <= 1 の場合の標準仕様は不明瞭ですが、一般的な実装では次のようになります。

• count < 1 の場合、何もしない、エラーを報告する。
• count == 1 の場合、

• 一部の実装では何もしない、エラーを報告する。
• 他の実装では何も読み取らず、str[0] にゼロを格納し、成功を報告する。

例

このコードを実行

#include <cstdio>
#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <span>
 
void dump(std::span<const char> buf, std::size_t offset)
{
    std::cout << std::dec;
    for (char ch : buf)
        std::cout << (ch >= ' ' ? ch : '.'), offset--;
    std::cout << std::string(offset, ' ') << std::hex
              << std::setfill('0') << std::uppercase;
    for (unsigned ch : buf)
        std::cout << std::setw(2) << ch << ' ';
    std::cout << std::dec << '\n';
}
 
int main()
{
    std::FILE* tmpf = std::tmpfile();
    std::fputs("Alan Turing\n", tmpf);
    std::fputs("John von Neumann\n", tmpf);
    std::fputs("Alonzo Church\n", tmpf);
 
    std::rewind(tmpf);
    for (char buf[8]; std::fgets(buf, sizeof buf, tmpf) != nullptr;)
        dump(buf, 10);
}

出力

Alan Tu.  41 6C 61 6E 20 54 75 00 
ring..u.  72 69 6E 67 0A 00 75 00 
John vo.  4A 6F 68 6E 20 76 6F 00 
n Neuma.  6E 20 4E 65 75 6D 61 00 
nn..uma.  6E 6E 0A 00 75 6D 61 00 
Alonzo .  41 6C 6F 6E 7A 6F 20 00 
Church..  43 68 75 72 63 68 0A 00

関連項目

scanffscanfsscanf	stdin、ファイルストリーム、またはバッファから書式付き入力を読み取ります。 (関数)
gets (C++11で非推奨)(C++14で削除)	stdinから文字列を読み取る (関数)
fputs	ファイルストリームに文字列を書き込む (関数)
fgets のCドキュメント