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