1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> 2<html lang="en"> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 5<meta http-equiv="Content-Style-Type" content="text/css"> 6<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 7<title>FatFs - f_gets</title> 8</head> 9 10<body> 11 12<div class="para func"> 13<h2>f_gets</h2> 14<p>The f_gets reads a string from the file.</p> 15<pre> 16TCHAR* f_gets ( 17 TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Read buffer */</span> 18 int <span class="arg">len</span>, <span class="c">/* [IN] Size of the read buffer */</span> 19 FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> 20); 21</pre> 22</div> 23 24<div class="para arg"> 25<h4>Parameters</h4> 26<dl class="par"> 27<dt>buff</dt> 28<dd>Pointer to read buffer to store the read string.</dd> 29<dt>len</dt> 30<dd>Size of the read buffer in unit of item.</dd> 31<dt>fp</dt> 32<dd>Pointer to the open file object structure.</dd> 33</dl> 34</div> 35 36 37<div class="para ret"> 38<h4>Return Values</h4> 39<p>When the function succeeded, <tt class="arg">buff</tt> will be returuned.</p> 40</div> 41 42 43<div class="para desc"> 44<h4>Description</h4> 45<p>The read operation continues until a <tt>'\n'</tt> is stored, reached end of the file or the buffer is filled with <tt>len - 1</tt> characters. The read string is terminated with a <tt>'\0'</tt>. 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 <tt>f_eof</tt> and <tt>f_error</tt> function.</p> 46<p>When FatFs is configured to Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> >= 1</tt>), data types on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt>, is also switched to Unicode. The character encoding <em>on the file</em> to be read via this function is assumed as <a href="config.html#strf_encode"><tt>FF_STRF_ENCODE</tt></a>. If the character encoding differs between file data and API, it is converted in this function. Input characters with wrong encoding for output will be lost.</p> 47</div> 48 49 50<div class="para comp"> 51<h4>QuickInfo</h4> 52<p>This is a wrapper function of <a href="read.html"><tt>f_read</tt></a> function. Available when <tt><a href="config.html#use_strfunc">FF_USE_STRFUNC</a> >= 1</tt>. When it is set to 2, <tt>'\r'</tt>s contained in the read data are stripped off.</p> 53</div> 54 55 56<div class="para ref"> 57<h4>See Also</h4> 58<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p> 59</div> 60 61 62<p class="foot"><a href="../00index_e.html">Return</a></p> 63</body> 64</html> 65