Add FatFs module by ChaN.
[bertos.git] / bertos / fs / fatfs / doc / en / puts.html
diff --git a/bertos/fs/fatfs/doc/en/puts.html b/bertos/fs/fatfs/doc/en/puts.html
new file mode 100644 (file)
index 0000000..69f2232
--- /dev/null
@@ -0,0 +1,54 @@
+<!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_puts</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para">\r
+<h2>f_puts</h2>\r
+<p>The f_puts function writes a string to the file.</p>\r
+<pre>\r
+int f_puts (\r
+  const char* <em>Str</em>,  /* String */\r
+  FIL* <em>FileObject</em>   /* File object */\r
+);\r
+</pre>\r
+</div>\r
+\r
+<div class="para">\r
+<h4>Parameters</h4>\r
+<dl class="par">\r
+<dt>Str</dt>\r
+<dd>Pointer to the null terminated string to be written. The null character will not be written.</dd>\r
+<dt>FileObject</dt>\r
+<dd>Pointer to the open file object structure.</dd>\r
+</dl>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>Return Value</h4>\r
+<p>When the function succeeded, number of characters written (not minus value) 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_puts() is a wrapper function of <a href="putc.html">f_putc()</a>. This function is available when read-write configuration and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set 2, a <tt>'\n'</tt> is extended to <tt>"\r\n"</tt>.</p>\r
+</div>\r
+\r
+\r
+<div class="para">\r
+<h4>Reference</h4>\r
+<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>\r
+</div>\r
+\r
+<p class="foot"><a href="../00index_e.html">Return</a></p>\r
+</body>\r
+</html>\r