<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

<meta http-equiv="Content-Style-Type" content="text/css">

<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">

<title>FatFs - f_truncate</title>

</head>



<body>



<div class="para func">

<h2>f_truncate</h2>

<p>The f_truncate function truncates the file size.</p>

<pre>

FRESULT f_truncate (

  FIL* <span class="arg">fp</span>     <span class="c">/* [IN] File object */</span>

);

</pre>

</div>



<div class="para arg">

<h4>Parameter</h4>

<dl class="par">

<dt>fp</dt>

<dd>Pointer to the open file object to be truncated. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd>

</dl>

</div>





<div class="para ret">

<h4>Return Values</h4>

<p>

<a href="rc.html#ok">FR_OK</a>,

<a href="rc.html#de">FR_DISK_ERR</a>,

<a href="rc.html#ie">FR_INT_ERR</a>,

<a href="rc.html#dn">FR_DENIED</a>,

<a href="rc.html#io">FR_INVALID_OBJECT</a>,

<a href="rc.html#tm">FR_TIMEOUT</a>

</p>

</div>





<div class="para desc">

<h4>Description</h4>

<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>

</div>





<div class="para comp">

<h4>QuickInfo</h4>

<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>

</div>





<div class="para ref">

<h4>See Also</h4>

<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p>

</div>





<p class="foot"><a href="../00index_e.html">Return</a></p>

</body>

</html>