]> cloudbase.mooo.com Git - z180-stamp.git/blame - fatfs/documents/doc/putc.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / documents / doc / putc.html
CommitLineData
53668523
L
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2<html lang="en">\r
3<head>\r
289f6a14 4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
53668523
L
5<meta http-equiv="Content-Style-Type" content="text/css">\r
6<link rel="up" title="FatFs" href="../00index_e.html">\r
7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/putc.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - f_putc</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>f_putc</h2>\r
16<p>The f_putc funciton puts a character to the file.</p>\r
17<pre>\r
18int f_putc (\r
289f6a14 19 TCHAR <span class="arg">chr</span>, <span class="c">/* [IN] A character to write */</span>\r
53668523
L
20 FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>\r
21);\r
22</pre>\r
23</div>\r
24\r
25<div class="para arg">\r
26<h4>Parameters</h4>\r
27<dl class="par">\r
28<dt>chr</dt>\r
289f6a14 29<dd>A character to write.</dd>\r
53668523
L
30<dt>fp</dt>\r
31<dd>Pointer to the open file object structuer.</dd>\r
32</dl>\r
33</div>\r
34\r
35\r
36<div class="para ret">\r
37<h4>Return Values</h4>\r
289f6a14 38<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
53668523
L
39</div>\r
40\r
41\r
289f6a14
L
42<div class="para desc">\r
43<h4>Description</h4>\r
44<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
45</div>\r
46\r
53668523
L
47<div class="para comp">\r
48<h4>QuickInfo</h4>\r
289f6a14 49<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
53668523
L
50</div>\r
51\r
52\r
53<div class="para ref">\r
54<h4>See Also</h4>\r
55<p><tt><a href="open.html">f_open</a>, <a href="puts.html">f_puts</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
56</div>\r
57\r
58<p class="foot"><a href="../00index_e.html">Return</a></p>\r
59</body>\r
60</html>\r