summaryrefslogtreecommitdiff
path: root/fatfs/doc/en/puts.html
diff options
context:
space:
mode:
authorLeo C2014-08-19 15:31:33 +0200
committerLeo C2014-08-19 15:31:33 +0200
commit5366852335044c1e68a5c32548d3051cc943552f (patch)
treeae01bc3fc61a98fcef5ce845d7b8ae07167f4b20 /fatfs/doc/en/puts.html
parent068e826f2c2e6265e7c527082db0b5b2802dc6c6 (diff)
downloadz180-stamp-5366852335044c1e68a5c32548d3051cc943552f.zip
Import fatfs R0.10bfatfs-0.10b
FatFs Module Source Files R0.10b Author: (C)ChaN, 2014 (http://elm-chan.org) URL: http://elm-chan.org/fsw/ff/ff10b.zip
Diffstat (limited to 'fatfs/doc/en/puts.html')
-rw-r--r--fatfs/doc/en/puts.html62
1 files changed, 62 insertions, 0 deletions
diff --git a/fatfs/doc/en/puts.html b/fatfs/doc/en/puts.html
new file mode 100644
index 0000000..30b1dd3
--- /dev/null
+++ b/fatfs/doc/en/puts.html
@@ -0,0 +1,62 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<link rel="up" title="FatFs" href="../00index_e.html">
+<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/puts.html">
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
+<title>FatFs - f_puts</title>
+</head>
+
+<body>
+
+<div class="para func">
+<h2>f_puts</h2>
+<p>The f_puts function writes a string to the file.</p>
+<pre>
+int f_puts (
+ const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span>
+ FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>
+);
+</pre>
+</div>
+
+<div class="para arg">
+<h4>Parameters</h4>
+<dl class="par">
+<dt>str</dt>
+<dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd>
+<dt>fp</dt>
+<dd>Pointer to the open file object structure.</dd>
+</dl>
+</div>
+
+
+<div class="para ret">
+<h4>Return Value</h4>
+<p>When the function succeeded, it returns number of characters written. When the write operation is aborted due to disk full or any error, an <tt>EOF (-1)</tt> will be returned.</p>
+<p>When FatFs is configured to Unicode API (<tt>_LFN_UNICODE == 1</tt>), character encoding on the srting fuctions, <tt>f_putc()</tt>, <tt>f_puts()</tt>, <tt>f_printf()</tt> and <tt>f_gets()</tt>, 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>
+</div>
+
+
+<div class="para desc">
+<h4>Description</h4>
+<p>The <tt>f_puts()</tt> function is a wrapper function of <a href="write.html"><tt>f_write()</tt></a> function.</p>
+</div>
+
+
+<div class="para comp">
+<h4>QuickInfo</h4>
+<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\n'</tt>s contained in the string are converted to <tt>'\r'+'\n'</tt>.</p>
+</div>
+
+
+<div class="para ref">
+<h4>See Also</h4>
+<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>
+</div>
+
+<p class="foot"><a href="../00index_e.html">Return</a></p>
+</body>
+</html>