puts.html 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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=iso-8859-1">
  5. <meta http-equiv="Content-Style-Type" content="text/css">
  6. <link rel="up" title="FatFs" href="../00index_e.html">
  7. <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/puts.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_puts</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_puts</h2>
  14. <p>The f_puts function writes a string to the file.</p>
  15. <pre>
  16. int f_puts (
  17. const TCHAR* <span class="arg">str</span>, <span class="c">/* [IN] String */</span>
  18. FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>str</dt>
  26. <dd>Pointer to the null terminated string to be written. The terminator character will not be written.</dd>
  27. <dt>fp</dt>
  28. <dd>Pointer to the open file object structure.</dd>
  29. </dl>
  30. </div>
  31. <div class="para ret">
  32. <h4>Return Value</h4>
  33. <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>
  34. <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>
  35. </div>
  36. <div class="para desc">
  37. <h4>Description</h4>
  38. <p>The <tt>f_puts()</tt> function is a wrapper function of <a href="write.html"><tt>f_write()</tt></a> function.</p>
  39. </div>
  40. <div class="para comp">
  41. <h4>QuickInfo</h4>
  42. <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>
  43. </div>
  44. <div class="para ref">
  45. <h4>See Also</h4>
  46. <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>
  47. </div>
  48. <p class="foot"><a href="../00index_e.html">Return</a></p>
  49. </body>
  50. </html>