Функция f_gets читает строку из файла.

TCHAR* f_gets (
  TCHAR* Str,       /* Буфер чтения */
  int Size,         /* Размер буфера чтения */
  FIL* FileObject   /* Файловый объект */
);

Параметры

Str

Указатель на буфер чтения, куда будет сохранена прочитанная из файла строка.

Size

Размер буфера чтения в символах.

FileObject

Указатель на структуру открытого файлового объекта.

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

Когда функция выполнилась успешно, то будет возвращена Str.

Описание

Функция f_gets() является простой оберткой над функцией f_read(). Операция чтения будет продолжаться до конца файла до тех пор, пока не будет сохранен символ '\n', либо до момента, когда буфер чтения не заполнится на Size - 1 символов. Прочитанная строка завершается нулем '\0'. Когда нет символов для чтения, или во время операции чтения произошла любая ошибка, функция f_gets() вернет нулевой указатель (null). Что именно произошло - конец файла EOF или какая-то ошибка, можно определить через использование макросов f_eof() и f_error().

Когда библиотека FatFs сконфигурирована в режиме Unicode API (_LFN_UNICODE == 1), файл читается в кодировке UTF-8, и сохраняется в буфер в кодировке UCS-2. В любом другом случае файл будет прочитан в соответствии один байт - один символ, без какой-либо перекодировки.

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

Функция доступна, когда опция _USE_STRFUNC равна 1 или 2. Когда опция установлена в 2, то содержащиеся в файле символы '\r' будут отброшены.

См. также

f_open, f_read, f_putc, f_puts, f_printf, f_close, FIL