Add FatFs module by ChaN.
[bertos.git] / bertos / fs / fatfs / doc / en / printf.html
diff --git a/bertos/fs/fatfs/doc/en/printf.html b/bertos/fs/fatfs/doc/en/printf.html
new file mode 100644 (file)
index 0000000..482d07d
--- /dev/null
@@ -0,0 +1,72 @@
+<!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-Style-Type" content="text/css">\r
+<link rel="up" title="FatFs" href="../00index_e.html">\r
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
+<title>FatFs - f_printf</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para">\r
+<h2>f_printf</h2>\r
+<p>The f_printf function writes formatted string to the file.</p>\r
+<pre>\r
+int f_printf (\r
+  FIL* <em>FileObject</em>,     /* File object */\r
+  const char* <em>Foramt</em>,  /* Format stirng */\r
+  ...\r
+);\r
+</pre>\r
+</div>\r
+\r
+<div class="para">\r
+<h4>Parameters</h4>\r
+<dl class="par">\r
+<dt>FileObject</dt>\r
+<dd>Pointer to the open file object structure.</dd>\r
+<dt>Format</dt>\r
+<dd>Pointer to the null-terminated format string.</dd>\r
+<dt>...</dt>\r
+<dd>Optional arguments.</dd>\r
+\r
+</dl>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>Return Values</h4>\r
+<p>When the function succeeded, number of characters written is returned. When the function failed due to disk full or any error, an <tt>EOF</tt> will be returned.</p>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>Description</h4>\r
+<p>The f_printf() is a wrapper function of <a href="putc.html">f_putc()</a> and <a href="puts.html">f_puts()</a>. The format control directive is a sub-set of standard library. It supports <tt>c s d u X</tt> for the data type, <tt>l</tt> for the precision and <tt>0</tt> for the flags.</p>\r
+<p>This function is available when read-write configuration and <tt>_USE_STRFUNC</tt> is 1 or 2.</p>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>Example</h4>\r
+<pre>\r
+    f_printf(&amp;fil, "%6d", -200);         // "  -200"\r
+    f_printf(&amp;fil, "%02u", 5);           // "05"\r
+    f_printf(&amp;fil, "%ld", 12345678L);    // "12345678"\r
+    f_printf(&amp;fil, "%08lX", 1194684UL);  // "00123ABC"\r
+    f_printf(&amp;fil, "%s", "String");      // "String"\r
+    f_printf(&amp;fil, "%c", 'a');           // "a"\r
+</pre>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>References</h4>\r
+<p><tt><a href="open.html">f_open</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="gets.html">f_gets</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>\r
+</div>\r
+\r
+<p class="foot"><a href="../00index_e.html">Return</a></p>\r
+</body>\r
+</html>\r