`fread_s`

Статья
06/16/2023

Считывает данные из потока. Эта версия имеет улучшения безопасности, как описано в функциях fread безопасности в CRT.

Синтаксис

size_t fread_s(
   void *buffer,
   size_t bufferSize,
   size_t elementSize,
   size_t count,
   FILE *stream
);

Параметры

buffer
Место хранения данных.

bufferSize
Размер буфера назначения в байтах.

elementSize
Размер читаемого элемента в байтах.

count
Максимальное число читаемых элементов.

stream
Указатель на структуру FILE .

Возвращаемое значение

Функция fread_s возвращает число полностью считанных в буфер элементов, которое может быть меньше count, если произошла ошибка чтения или конец файла был достигнут до того, как достигнуто значение count. Отличить ошибку от состояния, связанного с достижением конца файла, можно с помощью функции feof или ferror. Если size или count равно 0, функция fread_s возвращает 0, а содержимое буфера не изменяется. Если stream или buffer является пустым указателем, fread_s вызывает обработчик недопустимых параметров, как описано в разделе "Проверка параметров". Если продолжение выполнения разрешено, эта функции задает для errno значение EINVAL и возвращает 0.

Дополнительные сведения об кодах ошибок см. в разделе errno, _doserrno_sys_errlistи _sys_nerr.

Замечания

Функция fread_s считывает максимум count элементов размером elementSize байт из входного потока stream и сохраняет их в buffer. Указатель файла, связанный с stream (если он есть), расширен по количеству байтов fread_s , считываемых. Если заданный поток открыт в текстовом режиме, пары канала возвращаемой строки каретки заменяются символами однострочного канала. Замена не влияет на указатель файла или возвращаемое значение. В случае ошибки позиция указателя файла будет неопределенной. Значение элемента частичного чтения не может быть определено.

Эта функция блокирует работу других потоков. Неблокирующая версия функции называется _fread_nolock.

По умолчанию глобальное состояние этой функции ограничивается приложением. Чтобы изменить это поведение, см . статью "Глобальное состояние" в CRT.

Требования

Function	Обязательный заголовок
`fread_s`	`<stdio.h>`

Дополнительные сведения о совместимости см. в разделе Совместимость.

Пример

// crt_fread_s.c
// Command line: cl /EHsc /nologo /W4 crt_fread_s.c
//
// This program opens a file that's named FREAD.OUT and
// writes characters to the file. It then tries to open
// FREAD.OUT and read in characters by using fread_s. If the attempt succeeds,
// the program displays the number of actual items read.

#include <stdio.h>

#define BUFFERSIZE 30
#define DATASIZE 22
#define ELEMENTCOUNT 2
#define ELEMENTSIZE (DATASIZE/ELEMENTCOUNT)
#define FILENAME "FREAD.OUT"

int main( void )
{
   FILE *stream;
   char list[30];
   int  i, numread, numwritten;

   for ( i = 0; i < DATASIZE; i++ )
      list[i] = (char)('z' - i);
   list[DATASIZE] = '\0'; // terminal null so we can print it

   // Open file in text mode:
   if( fopen_s( &stream, FILENAME, "w+t" ) == 0 )
   {
      // Write DATASIZE characters to stream
      printf( "Contents of buffer before write/read:\n\t%s\n\n", list );
      numwritten = fwrite( list, sizeof( char ), DATASIZE, stream );
      printf( "Wrote %d items\n\n", numwritten );
      fclose( stream );
   } else {
      printf( "Problem opening the file\n" );
      return -1;
   }

   if( fopen_s( &stream, FILENAME, "r+t" ) == 0 )   {
      // Attempt to read in characters in 2 blocks of 11
      numread = fread_s( list, BUFFERSIZE, ELEMENTSIZE, ELEMENTCOUNT, stream );
      printf( "Number of %d-byte elements read = %d\n\n", ELEMENTSIZE, numread );
      printf( "Contents of buffer after write/read:\n\t%s\n", list );
      fclose( stream );
   } else {
      printf( "File could not be opened\n" );
      return -1;
   }
}

Contents of buffer before write/read:
        zyxwvutsrqponmlkjihgfe

Wrote 22 items

Number of 11-byte elements read = 2

Contents of buffer after write/read:
        zyxwvutsrqponmlkjihgfe

См. также

Потоковый ввод-вывод
fwrite
_read

Поделиться через