std::fread

 

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>で定義
std::size_t fread( void* buffer, std::size_t size, std::size_t count, std::FILE* stream );

指定された入力ストリームstreamから、配列bufferに最大count個のオブジェクトを読み込みます。これは、各オブジェクトに対してsize回std::fgetcを呼び出し、取得した結果を順にbufferの連続する位置に格納するのと同じです。bufferは、unsigned charの配列として再解釈されます。ストリームのファイル位置指示子は、読み取られた文字数だけ進められます。

オブジェクトがTriviallyCopyableでない場合、動作は未定義です。

エラーが発生した場合、ストリームのファイル位置指示子の結果の値は未定義になります。部分的な要素が読み取られた場合、その値は未定義になります。

パラメータ

buffer	-	読み取る配列の最初のオブジェクトへのポインタ
size	-	各オブジェクトのバイト単位のサイズ
count	-	読み取るオブジェクトの数
stream	-	読み込む入力ファイルストリーム

戻り値

正常に読み取られたオブジェクトの数。エラーまたはファイルの終端条件が発生した場合、countより少ない場合があります。

sizeまたはcountがゼロの場合、freadはゼロを返し、それ以外の操作は行いません。

freadはファイルの終端とエラーを区別せず、呼び出し元はどちらが発生したかを判断するためにstd::feofおよびstd::ferrorを使用する必要があります。

例

このコードを実行

#include <cstddef>
#include <cstdio>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <vector>
 
int main()
{
    // Prepare file
    std::ofstream("test.txt") << 1 << ' ' << 2 << '\n';
    std::FILE* f = std::fopen("test.txt", "r");
 
    std::vector<char> buf(4); // char is trivially copyable
    const std::size_t n = std::fread(&buf[0], sizeof buf[0], buf.size(), f);
 
    std::cout << "Read " << n << " object" << (n > 1 ? "s" : "") << ": "
              << std::hex << std::uppercase << std::setfill('0');
    for (char n : buf)
        std::cout << "0x" << std::setw(2) << static_cast<short>(n) << ' ';
    std::cout << '\n';
 
    std::vector<std::string> buf2; // string is not trivially copyable
//  This would result in undefined behavior:
//  std::fread(&buf2[0], sizeof buf2[0], buf2.size(), f);
}

実行結果の例

Read 4 objects: 0x31 0x20 0x32 0x0A

関連項目

scanffscanfsscanf	stdin、ファイルストリーム、またはバッファから書式付き入力を読み取ります。 (関数)
fgets	ファイルストリームから文字列を取得する (関数)
fwrite	ファイルに書き込む (関数)
Cドキュメント (fread)