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