FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/close.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=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_close</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_close</h2>
  15 <p>The f_close function closes an open file.</p>
  16 <pre>
  17 FRESULT f_close (
  18   FIL* <em>FileObject</em>     /* Pointer to the file object structure */
  19 );
  20 </pre>
  21 </div>
  22
  23 <div class="para">
  24 <h4>Parameter</h4>
  25 <dl class="par">
  26 <dt>FileObject</dt>
  27 <dd>Pointer to the open file object structure to be closed.</dd>
  28 </dl>
  29 </div>
  30
  31
  32 <div class="para">
  33 <h4>Return Values</h4>
  34 <dl class="ret">
  35 <dt>FR_OK (0)</dt>
  36 <dd>The file object has been closed successfuly.</dd>
  37 <dt>FR_DISK_ERR</dt>
  38 <dd>The function failed due to an error in the disk function.</dd>
  39 <dt>FR_INT_ERR</dt>
  40 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>
  41 <dt>FR_NOT_READY</dt>
  42 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  43 <dt>FR_INVALID_OBJECT</dt>
  44 <dd>The file object is invalid.</dd>
  45 </dl>
  46 </div>
  47
  48
  49 <div class="para">
  50 <h4>Description</h4>
  51 <p>The f_close function closes an open file object. If any data has been written to the file, the cached information of the file is written back to the disk. After the function succeeded, the file object is no longer valid and it can be discarded. If the file object has been opened in read-only mode, it may be discarded without closing process by this function.</p>
  52 </div>
  53
  54
  55 <div class="para">
  56 <h4>QuickInfo</h4>
  57 <p>Always available.</p>
  58 </div>
  59
  60
  61 <div class="para">
  62 <h4>See Also</h4>
  63 <p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="write.html">f_write</a>,  <a href="sync.html">f_sync</a>, <a href="sfile.html">FIL</a>, <a href="sfatfs.html">FATFS</a></tt></p>
  64 </div>
  65
  66 <p class="foot"><a href="../00index_e.html">Return</a></p>
  67 </body>
  68 </html>