FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/stat.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_stat</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_stat</h2>
  15 <p>The f_stat gets the file status.</p>
  16 <pre>
  17 FRESULT f_stat (
  18   const XCHAR* <em>FileName</em>,  /* Pointer to the file or directory name */
  19   FILINFO* <em>FileInfo</em>       /* Pointer to the FILINFO structure */
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para">
  25 <h4>Parameters</h4>
  26 <dl class="par">
  27 <dt>FileName</dt>
  28 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">file or directory</a> to get its information.</dd>
  29 <dt>FileInfo</dt>
  30 <dd>Pointer to the blank <tt>FILINFO</tt> structure to store the information.</dd>
  31 </dl>
  32 </div>
  33
  34
  35 <div class="para">
  36 <h4>Return Values</h4>
  37 <dl class="ret">
  38 <dt>FR_OK (0)</dt>
  39 <dd>The function succeeded.</dd>
  40 <dt>FR_NO_FILE</dt>
  41 <dd>Could not find the file or directory.</dd>
  42 <dt>FR_NO_PATH</dt>
  43 <dd>Could not find the path.</dd>
  44 <dt>FR_INVALID_NAME</dt>
  45 <dd>The file name is invalid.</dd>
  46 <dt>FR_INVALID_DRIVE</dt>
  47 <dd>The drive number is invalid.</dd>
  48 <dt>FR_NOT_READY</dt>
  49 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  50 <dt>FR_DISK_ERR</dt>
  51 <dd>The function failed due to an error in the disk function.</dd>
  52 <dt>FR_INT_ERR</dt>
  53 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>
  54 <dt>FR_NOT_ENABLED</dt>
  55 <dd>The logical drive has no work area.</dd>
  56 <dt>FR_NO_FILESYSTEM</dt>
  57 <dd>There is no valid FAT volume on the disk.</dd>
  58 </dl>
  59 </div>
  60
  61
  62 <div class="para">
  63 <h4>Description</h4>
  64 <p>The f_stat gets the information of a file or directory. For details of the infomation, refer to the <tt>FILINFO</tt> structure and <a href="readdir.html">f_readdir</a> function. This function is not supported in minimization level of &gt;= 1.</p>
  65 </div>
  66
  67
  68 <div class="para">
  69 <h4>References</h4>
  70 <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
  71 </div>
  72
  73 <p class="foot"><a href="../00index_e.html">Return</a></p>
  74 </body>
  75 </html>