truncate.html 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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/truncate.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_truncate</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_truncate</h2>
  14. <p>The f_truncate function truncates the file size.</p>
  15. <pre>
  16. FRESULT f_truncate (
  17. FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>
  18. );
  19. </pre>
  20. </div>
  21. <div class="para arg">
  22. <h4>Parameter</h4>
  23. <dl class="par">
  24. <dt>fp</dt>
  25. <dd>Pointer to the open file object to be truncated.</dd>
  26. </dl>
  27. </div>
  28. <div class="para ret">
  29. <h4>Return Values</h4>
  30. <p>
  31. <a href="rc.html#ok">FR_OK</a>,
  32. <a href="rc.html#de">FR_DISK_ERR</a>,
  33. <a href="rc.html#ie">FR_INT_ERR</a>,
  34. <a href="rc.html#nr">FR_NOT_READY</a>,
  35. <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  36. <a href="rc.html#tm">FR_TIMEOUT</a>
  37. </p>
  38. </div>
  39. <div class="para desc">
  40. <h4>Description</h4>
  41. <p>The <tt>f_truncate()</tt> function truncates the file size to the current file read/write pointer. This function has no effect if the file read/write pointer is already pointing end of the file.</p>
  42. </div>
  43. <div class="para comp">
  44. <h4>QuickInfo</h4>
  45. <p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
  46. </div>
  47. <div class="para ref">
  48. <h4>See Also</h4>
  49. <p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p>
  50. </div>
  51. <p class="foot"><a href="../00index_e.html">Return</a></p>
  52. </body>
  53. </html>