fatfs/documents/doc/truncate.html

   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=utf-8">
   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
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_truncate</h2>
  16 <p>The f_truncate function truncates the file size.</p>
  17 <pre>
  18 FRESULT f_truncate (
  19   FIL* <span class="arg">fp</span>     <span class="c">/* [IN] File object */</span>
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para arg">
  25 <h4>Parameter</h4>
  26 <dl class="par">
  27 <dt>fp</dt>
  28 <dd>Pointer to the open file object to be truncated.</dd>
  29 </dl>
  30 </div>
  31
  32
  33 <div class="para ret">
  34 <h4>Return Values</h4>
  35 <p>
  36 <a href="rc.html#ok">FR_OK</a>,
  37 <a href="rc.html#de">FR_DISK_ERR</a>,
  38 <a href="rc.html#ie">FR_INT_ERR</a>,
  39 <a href="rc.html#dn">FR_DENIED</a>,
  40 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  41 <a href="rc.html#tm">FR_TIMEOUT</a>
  42 </p>
  43 </div>
  44
  45
  46 <div class="para desc">
  47 <h4>Description</h4>
  48 <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>
  49 </div>
  50
  51
  52 <div class="para comp">
  53 <h4>QuickInfo</h4>
  54 <p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> == 0</tt>.</p>
  55 </div>
  56
  57
  58 <div class="para ref">
  59 <h4>See Also</h4>
  60 <p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p>
  61 </div>
  62
  63
  64 <p class="foot"><a href="../00index_e.html">Return</a></p>
  65 </body>
  66 </html>