]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/putc.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / documents / doc / putc.html
similarity index 54%
rename from fatfs/doc/en/putc.html
rename to fatfs/documents/doc/putc.html
index 9a97babaf3ef973640c18a861eabf41df1f36ae6..4d93bf508502f793e4133043e5359275c32aaa0f 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
 <html lang="en">\r
 <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
 <meta http-equiv="Content-Style-Type" content="text/css">\r
 <link rel="up" title="FatFs" href="../00index_e.html">\r
 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/putc.html">\r
@@ -16,7 +16,7 @@
 <p>The f_putc funciton puts a character to the file.</p>\r
 <pre>\r
 int f_putc (\r
-  TCHAR <span class="arg">chr</span>,  <span class="c">/* [IN] A character to put */</span>\r
+  TCHAR <span class="arg">chr</span>,  <span class="c">/* [IN] A character to write */</span>\r
   FIL* <span class="arg">fp</span>     <span class="c">/* [IN] File object */</span>\r
 );\r
 </pre>\r
@@ -26,7 +26,7 @@ int f_putc (
 <h4>Parameters</h4>\r
 <dl class="par">\r
 <dt>chr</dt>\r
-<dd>A character to be put.</dd>\r
+<dd>A character to write.</dd>\r
 <dt>fp</dt>\r
 <dd>Pointer to the open file object structuer.</dd>\r
 </dl>\r
@@ -35,14 +35,18 @@ int f_putc (
 \r
 <div class="para ret">\r
 <h4>Return Values</h4>\r
-<p>When the character was written successfuly, it returns number of characters written. When the function failed due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p>\r
-<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 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 character encoding on the file to be read/written via those functions is selected by <tt>_STRF_ENCODE</tt> option.</p>\r
+<p>When the character 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, an <tt>EOF (-1)</tt> will be returned.</p>\r
 </div>\r
 \r
 \r
+<div class="para desc">\r
+<h4>Description</h4>\r
+<p>When FatFs is configured for Unicode API (<tt><a href="config.html#lfn_unicode">FF_LFN_UNICODE</a> &gt;= 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 character encoding <em>on the file</em> to be read/written via those functions is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. The Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, cannot be written with this function.</p>\r
+</div>\r
+\r
 <div class="para comp">\r
 <h4>QuickInfo</h4>\r
-<p>This is a wrapper function of <a href="write.html"><tt>f_write</tt></a> function. Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, a <tt>'\n'</tt> is converted to <tt>'\r'+'\n'</tt>.</p>\r
+<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> &gt;= 1</tt>. When <tt>FF_USE_STRFUNC == 2</tt>, a <tt>'\n'</tt> is output as <tt>'\r'+'\n'</tt>.</p>\r
 </div>\r
 \r
 \r