1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> 2<html lang="en"> 3<head> 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="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 7<title>FatFs - f_puts</title> 8</head> 9 10<body> 11 12<div class="para func"> 13<h2>f_puts</h2> 14<p>The f_puts function writes a string to the file.</p> 15<pre> 16int f_puts ( 17 const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span> 18 FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span> 19); 20</pre> 21</div> 22 23<div class="para arg"> 24<h4>Parameters</h4> 25<dl class="par"> 26<dt>str</dt> 27<dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd> 28<dt>fp</dt> 29<dd>Pointer to the open file object structure.</dd> 30</dl> 31</div> 32 33 34<div class="para ret"> 35<h4>Return Value</h4> 36<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> 37</div> 38 39 40<div class="para desc"> 41<h4>Description</h4> 42<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>. If the character encoding differs between file data and API, it is converted in this function. Input characters with wrong encoding for output will be lost.</p> 43</div> 44 45 46<div class="para comp"> 47<h4>QuickInfo</h4> 48<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> 49</div> 50 51 52<div class="para ref"> 53<h4>See Also</h4> 54<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> 55</div> 56 57 58<p class="foot"><a href="../00index_e.html">Return</a></p> 59</body> 60</html> 61