1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
\r
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
\r
5 <meta http-equiv="Content-Style-Type" content="text/css">
\r
6 <link rel="up" title="FatFs" href="../00index_e.html">
\r
7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
\r
8 <title>FatFs - f_gets</title>
\r
15 <p>The f_gets reads a string from the file.</p>
\r
18 char* <em>Str</em>, /* Read buffer */
\r
19 int <em>Size</em>, /* Size of the read buffer */
\r
20 FIL* <em>FileObject</em> /* File object */
\r
29 <dd>Pointer to read buffer to store the read string.</dd>
\r
31 <dd>Size of the read buffer.</dd>
\r
33 <dd>Pointer to the open file object structure.</dd>
\r
39 <h4>Return Values</h4>
\r
40 <p>When the function succeeded, <tt>Str</tt> will be returuned.</p>
\r
45 <h4>Description</h4>
\r
46 <p>The f_gets() is a wrapper function of <a href="read.html">f_read()</a>. The read operation continues until a <tt>'\n'</tt> is stored, reached end of file or buffer is filled with Size - 1 characters. The read string is terminated with a <tt>'\0'</tt>. When the file has reached end of the file or any error occured during read operation, f_gets() returns a <tt>NULL</tt>. The EOF and error status can be examined with <tt>f_eof()</tt> and <tt>f_error()</tt> macro.</p>
\r
47 <p>This function is available when <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\r'</tt> contained in the file is stripped.</p>
\r
53 <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>
\r
56 <p class="foot"><a href="../00index_e.html">Return</a></p>
\r