projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 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/puts.html">\r | |
| 8 | <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_puts</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_puts</h2>\r | |
| 16 | <p>The f_puts function writes a string to the file.</p>\r | |
| 17 | <pre>\r | |
| 18 | int f_puts (\r | |
| 19 | const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span>\r | |
| 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>str</dt>\r | |
| 29 | <dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd>\r | |
| 30 | <dt>fp</dt>\r | |
| 31 | <dd>Pointer to the open file object structure.</dd>\r | |
| 32 | </dl>\r | |
| 33 | </div>\r | |
| 34 | \r | |
| 35 | \r | |
| 36 | <div class="para ret">\r | |
| 37 | <h4>Return Value</h4>\r | |
| 289f6a14 L |
38 | <p>When the string 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 EOF (-1) will be returned.</p>\r |
| 39 | </div>\r | |
| 40 | \r | |
| 41 | \r | |
| 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> >= 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 input Unicode characters in multiple encoding unit, such as surrogate pair and multi-byte sequence, should not be divided into two function calls, or the character will be lost. The character encoding <em>on the file</em> to be written via this functions is selected by <tt><a href="config.html#strf_encode">FF_STRF_ENCODE</a></tt>. The characters with wrong encoding or invalid for the output encoding will be lost.</p>\r | |
| 53668523 L |
45 | </div>\r |
| 46 | \r | |
| 47 | \r | |
| 48 | <div class="para comp">\r | |
| 49 | <h4>QuickInfo</h4>\r | |
| 289f6a14 | 50 | <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> >= 1</tt>. When <tt>FF_USE_STRFUNC == 2</tt>, <tt>'\n'</tt>s contained in the input string are output as <tt>'\r'+'\n'</tt> each.</p>\r |
| 53668523 L |
51 | </div>\r |
| 52 | \r | |
| 53 | \r | |
| 54 | <div class="para ref">\r | |
| 55 | <h4>See Also</h4>\r | |
| 56 | <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 | |
| 57 | </div>\r | |
| 58 | \r | |
| 59 | <p class="foot"><a href="../00index_e.html">Return</a></p>\r | |
| 60 | </body>\r | |
| 61 | </html>\r |