stat.html 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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/stat.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_stat</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_stat</h2>
  14. <p>The f_stat function checks the existence of a file or sub-directory.</p>
  15. <pre>
  16. FRESULT f_stat (
  17. const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span>
  18. FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] FILINFO structure */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>path</dt>
  26. <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">object</a> to get its information.</dd>
  27. <dt>fno</dt>
  28. <dd>Pointer to the blank <tt>FILINFO</tt> structure to store the information of the object. Set null pointer if it is not needed.</dd>
  29. </dl>
  30. </div>
  31. <div class="para ret">
  32. <h4>Return Values</h4>
  33. <p>
  34. <a href="rc.html#ok">FR_OK</a>,
  35. <a href="rc.html#de">FR_DISK_ERR</a>,
  36. <a href="rc.html#ie">FR_INT_ERR</a>,
  37. <a href="rc.html#nr">FR_NOT_READY</a>,
  38. <a href="rc.html#ok">FR_NO_FILE</a>,
  39. <a href="rc.html#np">FR_NO_PATH</a>,
  40. <a href="rc.html#in">FR_INVALID_NAME</a>,
  41. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  42. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  43. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  44. <a href="rc.html#tm">FR_TIMEOUT</a>,
  45. <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  46. </p>
  47. </div>
  48. <div class="para desc">
  49. <h4>Description</h4>
  50. <p>The <tt>f_stat</tt> function checks the existence of a file or sub-directory. If not exist, the function returns with <tt>FR_NO_FILE</tt>. If exist, the function returns with <tt>FR_OK</tt> and the informations of the object, file size, timestamp and attribute, are stored to the file information structure. For details of the file information, refer to the <tt>FILINFO</tt> structure and <a href="readdir.html"><tt>f_readdir</tt></a> function.</p>
  51. </div>
  52. <div class="para comp">
  53. <h4>QuickInfo</h4>
  54. <p>Available when <tt>_FS_MINIMIZE == 0</tt>.</p>
  55. </div>
  56. <div class="para use">
  57. <h4>Example</h4>
  58. <pre>
  59. FRESULT fr;
  60. FILINFO fno;
  61. printf("Test for 'file.txt'...\n");
  62. fr = f_stat("file.txt", &amp;fno);
  63. switch (fr) {
  64. case FR_OK:
  65. printf("Size: %lu\n", fno.fsize);
  66. printf("Timestamp: %u/%02u/%02u, %02u:%02u\n",
  67. (fno.fdate &gt;&gt; 9) + 1980, fno.fdate &gt;&gt; 5 &amp; 15, fno.fdate &amp; 31,
  68. fno.ftime &gt;&gt; 11, fno.ftime &gt;&gt; 5 &amp; 63);
  69. printf("Attributes: %c%c%c%c%c\n",
  70. (fno.fattrib &amp; AM_DIR) ? 'D' : '-',
  71. (fno.fattrib &amp; AM_RDO) ? 'R' : '-',
  72. (fno.fattrib &amp; AM_HID) ? 'H' : '-',
  73. (fno.fattrib &amp; AM_SYS) ? 'S' : '-',
  74. (fno.fattrib &amp; AM_ARC) ? 'A' : '-');
  75. break;
  76. case FR_NO_FILE:
  77. printf("It is not exist.\n");
  78. break;
  79. default:
  80. printf("An error occured. (%d)\n", fr);
  81. }
  82. </pre>
  83. </div>
  84. <div class="para ref">
  85. <h4>References</h4>
  86. <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
  87. </div>
  88. <p class="foot"><a href="../00index_e.html">Return</a></p>
  89. </body>
  90. </html>