Функция pf_read читает данные из файла.

FRESULT pf_read (
  void* Buffer,       /* Указатель на буфер чтения данных */
  WORD ByteToRead,    /* Количество байт для чтения */
  WORD* BytesRead     /* Указатель на переменную для количества прочитанных байт */
);

Параметры

Buffer

Указатель на буфер, куда будут помещены прочитанные данные. Параметр, равный NULL, указывает в качестве назначения выходной поток (outgoing stream).

ByteToRead

Количество байт для чтения.

BytesRead

Указатель на переменную типа WORD, в которой будет возвращено количество прочитанных байт.

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

FR_OK (0)

Функция завершилась успешно.

FR_DISK_ERR

Функция завершилась неудачно из-за ошибки в работе диска, испорченной структуры FAT или из-за внутренней ошибки.

FR_NOT_OPENED

Файл не был открыт.

FR_NOT_ENABLED

Том не был смонтирован.

Описание

Позиция чтения в файле (read pointer) в объекте файловой системы (file system object) увеличится на количество прочитанных байт. После успешного завершения функции переменная *BytesRead должна быть проверена, чтобы определить конец файла (end of file, EOF). Если *BytesRead < ByteToRead, то позиция чтения достигла конца файла при операции чтения.

Если в параметре Buffer указано значение NULL, то читаемые данные будут перенаправлены в выходной поток вместо памяти. Функция потоковой передачи (streaming function) обычно встроена в систему как низкоуровневая функция чтения диска.

Краткая информация (QuickInfo)

Функция доступна, когда _USE_READ == 1.

См. также

pf_open, pf_write, FATFS