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="up" title="FatFs" href="../00index_e.html"> 7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/gets.html"> 8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 9<title>FatFs - f_gets</title> 10</head> 11 12<body> 13 14<div class="para func"> 15<h2>f_gets</h2> 16<p>The f_gets reads a string from the file.</p> 17<pre> 18TCHAR* f_gets ( 19 TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Read buffer */</span> 20 int <span class="arg">len</span>, <span class="c">/* [IN] Size of the read buffer */</span> 21 FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> 22); 23</pre> 24</div> 25 26<div class="para arg"> 27<h4>Parameters</h4> 28<dl class="par"> 29<dt>buff</dt> 30<dd>Pointer to read buffer to store the read string.</dd> 31<dt>len</dt> 32<dd>Size of the read buffer in unit of item.</dd> 33<dt>fp</dt> 34<dd>Pointer to the open file object structure.</dd> 35</dl> 36</div> 37 38 39<div class="para ret"> 40<h4>Return Values</h4> 41<p>When the function succeeded, <tt class="arg">buff</tt> will be returuned.</p> 42</div> 43 44 45<div class="para desc"> 46<h4>Description</h4> 47<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> 48<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 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.</p> 49</div> 50 51 52<div class="para comp"> 53<h4>QuickInfo</h4> 54<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 file are stripped out.</p> 55</div> 56 57 58<div class="para ref"> 59<h4>See Also</h4> 60<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> 61</div> 62 63<p class="foot"><a href="../00index_e.html">Return</a></p> 64</body> 65</html> 66