ugfx/3rdparty/fatfs-0.13/documents/doc/puts.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="up" title="FatFs" href="../00index_e.html">
<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/puts.html">
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
<title>FatFs - f_puts</title>
</head>

<body>

<div class="para func">
<h2>f_puts</h2>
<p>The f_puts function writes a string to the file.</p>
<pre>
int f_puts (
  const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span>
  FIL* <span class="arg">fp</span>           <span class="c">/* [IN] File object */</span>
);
</pre>
</div>

<div class="para arg">
<h4>Parameters</h4>
<dl class="par">
<dt>str</dt>
<dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd>
<dt>fp</dt>
<dd>Pointer to the open file object structure.</dd>
</dl>
</div>


<div class="para ret">
<h4>Return Value</h4>
<p>When the function succeeded, it returns number of characters written. When the write operation is aborted due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p>
<p>When FatFs is configured to Unicode API (<tt>FF_LFN_UNICODE == 1</tt>), character encoding on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>FF_STRF_ENCODE</tt> option.</p>
</div>


<div class="para comp">
<h4>QuickInfo</h4>
<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>FF_FS_READONLY == 0</tt> and <tt>FF_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\n'</tt>s contained in the string are converted to <tt>'\r'+'\n'</tt>.</p>
</div>


<div class="para ref">
<h4>See Also</h4>
<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
</div>

<p class="foot"><a href="../00index_e.html">Return</a></p>
</body>
</html>
Move 3rd Party source to a new directory. Rationalise Fatfs code and fix a couple of configuration issues. 2014-08-13 05:48:16 +00:00			`<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">`
			`<html lang="en">`
			`<head>`
			`<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">`
			`<meta http-equiv="Content-Style-Type" content="text/css">`
			`<link rel="up" title="FatFs" href="../00index_e.html">`
			`<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/puts.html">`
			`<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">`
			`<title>FatFs - f_puts</title>`
			`</head>`

			`<body>`

			`<div class="para func">`
			`<h2>f_puts</h2>`
			`<p>The f_puts function writes a string to the file.</p>`
			`<pre>`
			`int f_puts (`
			`const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span>`
			`FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>`
			`);`
			`</pre>`
			`</div>`

			`<div class="para arg">`
			`<h4>Parameters</h4>`
			`<dl class="par">`
			`<dt>str</dt>`
			`<dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd>`
			`<dt>fp</dt>`
			`<dd>Pointer to the open file object structure.</dd>`
			`</dl>`
			`</div>`


			`<div class="para ret">`
			`<h4>Return Value</h4>`
			`<p>When the function succeeded, it returns number of characters written. When the write operation is aborted due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p>`
Upgrade to from FATFS-0.10b to FATFS-0.13 2017-06-24 06:35:31 +00:00			`<p>When FatFs is configured to Unicode API (<tt>FF_LFN_UNICODE == 1</tt>), character encoding on the srting fuctions, <tt>f_putc</tt>, <tt>f_puts</tt>, <tt>f_printf</tt> and <tt>f_gets</tt> function, is also switched to Unicode. The character encoding on the file to be read/written via those functions is selected by <tt>FF_STRF_ENCODE</tt> option.</p>`
Move 3rd Party source to a new directory. Rationalise Fatfs code and fix a couple of configuration issues. 2014-08-13 05:48:16 +00:00			`</div>`


			`<div class="para comp">`
			`<h4>QuickInfo</h4>`
Upgrade to from FATFS-0.10b to FATFS-0.13 2017-06-24 06:35:31 +00:00			`<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>FF_FS_READONLY == 0</tt> and <tt>FF_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\n'</tt>s contained in the string are converted to <tt>'\r'+'\n'</tt>.</p>`
Move 3rd Party source to a new directory. Rationalise Fatfs code and fix a couple of configuration issues. 2014-08-13 05:48:16 +00:00			`</div>`


			`<div class="para ref">`
			`<h4>See Also</h4>`
			`<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="printf.html">f_printf</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>`
			`</div>`

			`<p class="foot"><a href="../00index_e.html">Return</a></p>`
			`</body>`
			`</html>`