write.html 2.4 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="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  8. <title>FatFs - f_write</title>
  9. </head>
  10. <body>
  11. <div class="para">
  12. <h2>f_write</h2>
  13. <p>The f_write writes data to a file.</p>
  14. <pre>
  15. FRESULT f_write (
  16. FIL* <em>FileObject</em>, /* Pointer to the file object structure */
  17. const void* <em>Buffer</em>, /* Pointer to the data to be written */
  18. UINT <em>ByteToWrite</em>, /* Number of bytes to write */
  19. UINT* <em>ByteWritten</em> /* Pointer to the variable to return number of bytes written */
  20. );
  21. </pre>
  22. </div>
  23. <div class="para">
  24. <h4>Parameters</h4>
  25. <dl class="par">
  26. <dt>FileObject</dt>
  27. <dd>Pointer to the open file object structure.</dd>
  28. <dt>Buffer</dt>
  29. <dd>Pointer to the data to be written.</dd>
  30. <dt>ByteToWrite</dt>
  31. <dd>Specifies number of bytes to write in range of UINT.</dd>
  32. <dt>ByteWritten</dt>
  33. <dd>Pointer to the UINT variable to return number of bytes written.</dd>
  34. </dl>
  35. </div>
  36. <div class="para">
  37. <h4>Return Values</h4>
  38. <dl class="ret">
  39. <dt>FR_OK (0)</dt>
  40. <dd>The function succeeded.</dd>
  41. <dt>FR_DENIED</dt>
  42. <dd>The function denied due to the file has been opened in non-write mode.</dd>
  43. <dt>FR_RW_ERROR</dt>
  44. <dd>The function failed due to a disk error or an internal error.</dd>
  45. <dt>FR_NOT_READY</dt>
  46. <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  47. <dt>FR_INVALID_OBJECT</dt>
  48. <dd>The file object is invalid.</dd>
  49. </dl>
  50. </div>
  51. <div class="para">
  52. <h4>Description</h4>
  53. <p>The read/write pointer in the file object is increased in number of bytes written. After the function succeeded, <tt>*ByteWritten</tt> should be checked to detect disk full. In case of <tt>*ByteWritten &lt; ByteToWrite</tt>, it means the disk got full during write operation.</p>
  54. <p>This function is not supported in read-only configuration.</p>
  55. </div>
  56. <div class="para">
  57. <h4>References</h4>
  58. <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>
  59. </div>
  60. <p class="foot"><a href="../00index_e.html">Return</a></p>
  61. </body>
  62. </html>