projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="en">\r | |
| 3 | <head>\r | |
| 289f6a14 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
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="alternate" hreflang="ja" title="Japanese" href="../ja/gets.html">\r | |
| 8 | <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_gets</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_gets</h2>\r | |
| 16 | <p>The f_gets reads a string from the file.</p>\r | |
| 17 | <pre>\r | |
| 18 | TCHAR* f_gets (\r | |
| 19 | TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Read buffer */</span>\r | |
| 20 | int <span class="arg">len</span>, <span class="c">/* [IN] Size of the read buffer */</span>\r | |
| 21 | FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>\r | |
| 22 | );\r | |
| 23 | </pre>\r | |
| 24 | </div>\r | |
| 25 | \r | |
| 26 | <div class="para arg">\r | |
| 27 | <h4>Parameters</h4>\r | |
| 28 | <dl class="par">\r | |
| 29 | <dt>buff</dt>\r | |
| 30 | <dd>Pointer to read buffer to store the read string.</dd>\r | |
| 31 | <dt>len</dt>\r | |
| 289f6a14 | 32 | <dd>Size of the read buffer in unit of item.</dd>\r |
| 53668523 L |
33 | <dt>fp</dt>\r |
| 34 | <dd>Pointer to the open file object structure.</dd>\r | |
| 35 | </dl>\r | |
| 36 | </div>\r | |
| 37 | \r | |
| 38 | \r | |
| 39 | <div class="para ret">\r | |
| 40 | <h4>Return Values</h4>\r | |
| 41 | <p>When the function succeeded, <tt class="arg">buff</tt> will be returuned.</p>\r | |
| 42 | </div>\r | |
| 43 | \r | |
| 44 | \r | |
| 45 | <div class="para desc">\r | |
| 46 | <h4>Description</h4>\r | |
| 70702af1 | 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>\r |
| 289f6a14 | 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>\r |
| 53668523 L |
49 | </div>\r |
| 50 | \r | |
| 51 | \r | |
| 52 | <div class="para comp">\r | |
| 53 | <h4>QuickInfo</h4>\r | |
| 289f6a14 | 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>\r |
| 53668523 L |
55 | </div>\r |
| 56 | \r | |
| 57 | \r | |
| 58 | <div class="para ref">\r | |
| 59 | <h4>See Also</h4>\r | |
| 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>\r | |
| 61 | </div>\r | |
| 62 | \r | |
| 63 | <p class="foot"><a href="../00index_e.html">Return</a></p>\r | |
| 64 | </body>\r | |
| 65 | </html>\r |