fread
ストリームからデータを読み出します。
size_t fread(
void *buffer,
size_t size,
size_t count,
FILE *stream
);
パラメーター
buffer
データの格納場所。size
項目のサイズ (バイト単位)。count
読み出す最大項目数。stream
FILE 構造体へのポインター。
戻り値
fread は、実際に読み取った完全な項目の数を返します。この数は、エラーが発生した場合や、count に達する前にファイルの終端に達した場合に、count より少なることがあります。読み取りエラーが発生した場合とファイルの終端に達した場合を区別するには、feof 関数または ferror 関数を使用します。 size または count が 0 の場合、fread は 0 を返し、バッファーの内容は変わりません。 stream または buffer が null ポインターの場合、「パラメーターの検証」に説明されているように、fread は無効なパラメーター ハンドラーを呼び出します。 実行の継続が許可された場合、この関数は errno を EINVAL に設定し、0 を返します。
エラー コードの詳細については、「_doserrno、errno、_sys_errlist、および _sys_nerr」を参照してください。
解説
fread 関数は、入力 stream から size バイトの項目を最大 count の数まで読み取り、buffer に格納します。stream に関連付けられたファイル ポインターがある場合、ファイル ポインターは、実際に読み出されたバイト数だけ増加します。 指定のストリームがテキスト モードで開いている場合、キャリッジ リターンとライン フィード (CR-LF: carriage return–linefeed) は単独のライン フィード (LF: linefeed) 文字に置換されます。 この置換は、ファイル ポインターや戻り値には影響しません。 エラーが発生した場合、ファイル ポインターの位置は不確定になります。 一部だけ読み出された項目の値は確定できません。
この関数は他のスレッドをロックアウトします。 ロックされないバージョンが必要な場合は、_fread_nolock を使用します。
必要条件
機能 |
必須ヘッダー |
|---|---|
fread |
<stdio.h> |
互換性の詳細については、「C ランタイム ライブラリ」の「互換性」を参照してください。
使用例
// crt_fread.c
// This program opens a file named FREAD.OUT and
// writes 25 characters to the file. It then tries to open
// FREAD.OUT and read in 25 characters. If the attempt succeeds,
// the program displays the number of actual items read.
#include <stdio.h>
int main( void )
{
FILE *stream;
char list[30];
int i, numread, numwritten;
// Open file in text mode:
if( fopen_s( &stream, "fread.out", "w+t" ) == 0 )
{
for ( i = 0; i < 25; i++ )
list[i] = (char)('z' - i);
// Write 25 characters to stream
numwritten = fwrite( list, sizeof( char ), 25, stream );
printf( "Wrote %d items\n", numwritten );
fclose( stream );
}
else
printf( "Problem opening the file\n" );
if( fopen_s( &stream, "fread.out", "r+t" ) == 0 )
{
// Attempt to read in 25 characters
numread = fread( list, sizeof( char ), 25, stream );
printf( "Number of items read = %d\n", numread );
printf( "Contents of buffer = %.25s\n", list );
fclose( stream );
}
else
printf( "File could not be opened\n" );
}