Namespaces
Variants

fread

ja.cppreference.net から
< c | io
 
 
ファイル入出力
型とオブジェクト
        
関数
ファイルアクセス
(C95)
書式なし入出力
(C95)(C95)
(C95)
(C95)(C95)
(C95)
(C95)

書式付き入力
 
ヘッダで定義 <stdio.h>
size_t fread( void* buffer, size_t size, size_t count,
              FILE* stream );
(C99まで)
size_t fread( void* restrict buffer, size_t size, size_t count,
              FILE* restrict stream );
(C99から)

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

エラーが発生した場合、ストリームのファイル位置指示子の結果の値は不定である。部分的な要素が読み込まれた場合、その値は不定である。

引数

buffer - 読み込まれたオブジェクトが格納される配列へのポインタ
size - 各オブジェクトのサイズ(バイト単位)
count - 読み込むオブジェクトの数
stream - 読み込むストリーム

戻り値

正常に読み込まれたオブジェクトの数。エラーまたはファイル終了条件が発生した場合、count より小さくなることがある。

もし size または count がゼロの場合、fread はゼロを返し、それ以外の動作は行わない。

fread はファイル終了とエラーを区別しない。呼び出し側は feof と ferror を使用してどちらが発生したかを判断しなければならない。

例

#include <stdio.h>

enum { SIZE = 5 };

int main(void)
{
    const double a[SIZE] = {1.0, 2.0, 3.0, 4.0, 5.0};
    printf("Array has size %ld bytes, element size: %ld\n", sizeof a, sizeof* a);
    FILE* fp = fopen("test.bin", "wb"); // must use binary mode
    fwrite(a, sizeof* a, SIZE, fp); // writes an array of doubles
    fclose(fp);

    double b[SIZE];
    fp = fopen("test.bin","rb");
    const size_t ret_code = fread(b, sizeof b[0], SIZE, fp); // reads an array of doubles
    if (ret_code == SIZE)
    {
        printf("Array at %p read successfully, contents:\n", (void*)&a);
        for (int n = 0; n != SIZE; ++n)
            printf("%f ", b[n]);
        putchar('\n');
    }
    else // error handling
    {
        if (feof(fp))
            printf("Error reading test.bin: unexpected end of file\n");
        else if (ferror(fp))
            perror("Error reading test.bin");
    }

    fclose(fp);
}

出力例:

Array has size 40 bytes, element size: 8
Array at 0x1337f00d6960 read successfully, contents:
1.000000 2.000000 3.000000 4.000000 5.000000

参考文献

  • C23 規格 (ISO/IEC 9899:2024):
  • 7.21.8.1 fread 関数 (p: TBD)
  • C17 規格 (ISO/IEC 9899:2018):
  • 7.21.8.1 fread 関数 (p: 243-244)
  • C11 規格 (ISO/IEC 9899:2011):
  • 7.21.8.1 fread 関数 (p: 335)
  • C99 規格 (ISO/IEC 9899:1999):
  • 7.19.8.1 fread 関数 (p: 301)
  • C89/C90 規格 (ISO/IEC 9899:1990):
  • 4.9.8.1 fread 関数

関連項目

stdin、ファイルストリーム、またはバッファ
(関数) から書式付き入力を読み込む
ファイルストリーム
(関数) から文字列を取得する
ファイル
(関数) に書き込む