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