From 289f6a146c0b2087607d8d8659531ea90142779a Mon Sep 17 00:00:00 2001 From: Leo C Date: Sun, 27 May 2018 21:26:38 +0200 Subject: Import fatfs R0.13b --- fatfs/documents/doc/gets.html | 65 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 fatfs/documents/doc/gets.html (limited to 'fatfs/documents/doc/gets.html') diff --git a/fatfs/documents/doc/gets.html b/fatfs/documents/doc/gets.html new file mode 100644 index 0000000..8ab46f4 --- /dev/null +++ b/fatfs/documents/doc/gets.html @@ -0,0 +1,65 @@ + + +
+ + + + + +The f_gets reads a string from the file.
++TCHAR* f_gets ( + TCHAR* buff, /* [OUT] Read buffer */ + int len, /* [IN] Size of the read buffer */ + FIL* fp /* [IN] File object */ +); ++
When the function succeeded, buff will be returuned.
+The read operation continues until a '\n' is stored, reached end of the file or the buffer is filled with len - 1 characters. The read string is terminated with a '\0'. When no character to read or any error occured during read operation, it returns a null pointer. The status of EOF and error can be examined with f_eof and f_error function.
+When FatFs is configured to Unicode API (FF_LFN_UNICODE >= 1), data types on the srting fuctions, f_putc, f_puts, f_printf and f_gets, is also switched to Unicode. The character encoding on the file to be read via this function is assumed as FF_STRF_ENCODE. If the character encoding on the file differs from that on the API, it is converted in this function. In this case, input characters with wrong encoding will be lost.
+
This is a wrapper function of f_read function. Available when FF_USE_STRFUNC >= 1. When it is set to 2, '\r's contained in the file are stripped out.
+