1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
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/puts.html">
8 <link rel=
"stylesheet" href=
"../css_e.css" type=
"text/css" media=
"screen" title=
"ELM Default">
9 <title>FatFs - f_puts
</title>
14 <div class=
"para func">
16 <p>The f_puts function writes a string to the file.
</p>
19 const TCHAR*
<span class=
"arg">str
</span>,
<span class=
"c">/* [IN] String */
</span>
20 FIL*
<span class=
"arg">fp
</span> <span class=
"c">/* [IN] File object */
</span>
25 <div class=
"para arg">
29 <dd>Pointer to the null terminated string to be written. The terminator character will not be written.
</dd>
31 <dd>Pointer to the open file object structure.
</dd>
36 <div class=
"para ret">
38 <p>When the string was written successfuly, it returns number of character encoding units written to the file. When the function failed due to disk full or any error, a negative value will be returned.
</p>
42 <div class=
"para desc">
44 <p>When FatFs is configured for Unicode API (
<tt><a href=
"config.html#lfn_unicode">FF_LFN_UNICODE
</a> >=
1</tt>), character encoding on the string 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 input Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding
<em>on the file
</em> to be written via this functions is selected by
<tt><a href=
"config.html#strf_encode">FF_STRF_ENCODE
</a></tt>. The characters with wrong encoding or invalid for the output encoding will be lost.
</p>
48 <div class=
"para comp">
50 <p>This is a wrapper function of
<a href=
"write.html"><tt>f_write
</tt></a> function. Available when
<tt><a href=
"config.html#fs_readonly">FF_FS_READONLY
</a> ==
0</tt> and
<tt><a href=
"config.html#use_strfunc">FF_USE_STRFUNC
</a> >=
1</tt>. When
<tt>FF_USE_STRFUNC ==
2</tt>,
<tt>'\n'
</tt>s contained in the input string are output as
<tt>'\r'+'\n'
</tt> each.
</p>
54 <div class=
"para ref">
56 <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>
59 <p class=
"foot"><a href=
"../00index_e.html">Return
</a></p>