write.html 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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/write.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_write</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_write</h2>
  14. <p>The f_write writes data to a file.</p>
  15. <pre>
  16. FRESULT f_write (
  17. FIL* <span class="arg">fp</span>, <span class="c">/* [IN] Pointer to the file object structure */</span>
  18. const void* <span class="arg">buff</span>, <span class="c">/* [IN] Pointer to the data to be written */</span>
  19. UINT <span class="arg">btw</span>, <span class="c">/* [IN] Number of bytes to write */</span>
  20. UINT* <span class="arg">bw</span> <span class="c">/* [OUT] Pointer to the variable to return number of bytes written */</span>
  21. );
  22. </pre>
  23. </div>
  24. <div class="para arg">
  25. <h4>Parameters</h4>
  26. <dl class="par">
  27. <dt>fp</dt>
  28. <dd>Pointer to the open file object structure.</dd>
  29. <dt>buff</dt>
  30. <dd>Pointer to the data to be written.</dd>
  31. <dt>btw</dt>
  32. <dd>Specifies number of bytes to write in range of <tt>UINT</tt> type.</dd>
  33. <dt>bw</dt>
  34. <dd>Pointer to the <tt>UINT</tt> variable to return the number of bytes written. The value is always valid after the function call regardless of the result code.</dd>
  35. </dl>
  36. </div>
  37. <div class="para ret">
  38. <h4>Return Values</h4>
  39. <p>
  40. <a href="rc.html#ok">FR_OK</a>,
  41. <a href="rc.html#de">FR_DISK_ERR</a>,
  42. <a href="rc.html#ie">FR_INT_ERR</a>,
  43. <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  44. <a href="rc.html#tm">FR_TIMEOUT</a>
  45. </p>
  46. </div>
  47. <div class="para desc">
  48. <h4>Description</h4>
  49. <p>The function starts to write data to the file at the position pointed by the read/write pointer. The read/write pointer advances as number of bytes written. After the function succeeded, <tt class="arg">*bw</tt> should be checked to detect the disk full. In case of <tt class="arg">*bw</tt> &lt; <tt class="arg">btw</tt>, it means the volume got full during the write operation. The function can take a time when the volume is full or close to full.</p>
  50. </div>
  51. <div class="para comp">
  52. <h4>QuickInfo</h4>
  53. <p>Available when <tt>_FS_READONLY == 0</tt>.</p>
  54. </div>
  55. <div class="para ref">
  56. <h4>See Also</h4>
  57. <p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">fputc</a>, <a href="puts.html">fputs</a>, <a href="printf.html">fprintf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
  58. </div>
  59. <p class="foot"><a href="../00index_e.html">Return</a></p>
  60. </body>
  61. </html>