From 5366852335044c1e68a5c32548d3051cc943552f Mon Sep 17 00:00:00 2001 From: Leo C Date: Tue, 19 Aug 2014 15:31:33 +0200 Subject: Import fatfs R0.10b FatFs Module Source Files R0.10b Author: (C)ChaN, 2014 (http://elm-chan.org) URL: http://elm-chan.org/fsw/ff/ff10b.zip --- fatfs/doc/en/gets.html | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 fatfs/doc/en/gets.html (limited to 'fatfs/doc/en/gets.html') diff --git a/fatfs/doc/en/gets.html b/fatfs/doc/en/gets.html new file mode 100644 index 0000000..c843952 --- /dev/null +++ b/fatfs/doc/en/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 f_gets() function is a wrapper function of f_read() function. 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() macros.
+When FatFs is configured to Unicode API (_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/written via those functions is selected by _STRF_ENCODE option.
+Available when _USE_STRFUNC is 1 or 2. When it is set to 2, '\r's contained in the file are stripped out.
+