fatfs/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="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
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_stat</h2>
  16 <p>The f_stat function checks the existence of a file or sub-directory.</p>
  17 <pre>
  18 FRESULT f_stat (
  19   const TCHAR* <span class="arg">path</span>,  <span class="c">/* [IN] Object name */</span>
  20   FILINFO* <span class="arg">fno</span>        <span class="c">/* [OUT] FILINFO structure */</span>
  21 );
  22 </pre>
  23 </div>
  24
  25 <div class="para arg">
  26 <h4>Parameters</h4>
  27 <dl class="par">
  28 <dt>path</dt>
  29 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">object</a> to get its information.</dd>
  30 <dt>fno</dt>
  31 <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>
  32 </dl>
  33 </div>
  34
  35
  36 <div class="para ret">
  37 <h4>Return Values</h4>
  38 <p>
  39 <a href="rc.html#ok">FR_OK</a>,
  40 <a href="rc.html#de">FR_DISK_ERR</a>,
  41 <a href="rc.html#ie">FR_INT_ERR</a>,
  42 <a href="rc.html#nr">FR_NOT_READY</a>,
  43 <a href="rc.html#ok">FR_NO_FILE</a>,
  44 <a href="rc.html#np">FR_NO_PATH</a>,
  45 <a href="rc.html#in">FR_INVALID_NAME</a>,
  46 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  47 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  48 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  49 <a href="rc.html#tm">FR_TIMEOUT</a>,
  50 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  51 </p>
  52 </div>
  53
  54
  55 <div class="para desc">
  56 <h4>Description</h4>
  57 <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, attribute and SFN, 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>
  58 <p>When LFN feature is enabled, <tt>lfname</tt> in the file information structure must be NULLed prior to use it.</p>
  59 </div>
  60
  61
  62 <div class="para comp">
  63 <h4>QuickInfo</h4>
  64 <p>Available when <tt>_FS_MINIMIZE == 0</tt>.</p>
  65 </div>
  66
  67
  68 <div class="para use">
  69 <h4>Example</h4>
  70 <pre>
  71     FRESULT fr;
  72     FILINFO fno;
  73
  74
  75     printf("Test for 'file.txt'...\n");
  76
  77 <span class="k">#if</span> _USE_LFN
  78     fno.lfname = 0;
  79 <span class="k">#endif</span>
  80     fr = f_stat("file.txt", &amp;fno);
  81     switch (fr) {
  82
  83     case FR_OK:
  84         printf("Size: %u\n", fno.fsize);
  85         printf("Timestamp: %u/%02u/%02u, %02u:%02u\n",
  86                (fno.fdate &gt;&gt; 9) + 1980, fno.fdate &gt;&gt; 5 &amp; 15, fno.fdate &amp; 31,
  87                fno.ftime &gt;&gt; 11, fno.ftime &gt;&gt; 5 &amp; 63);
  88         printf("Attributes: %c%c%c%c%c\n",
  89                (fno.fattrib & AM_DIR) ? 'D' : '-',
  90                (fno.fattrib & AM_RDO) ? 'R' : '-',
  91                (fno.fattrib & AM_HID) ? 'H' : '-',
  92                (fno.fattrib & AM_SYS) ? 'S' : '-',
  93                (fno.fattrib & AM_ARC) ? 'A' : '-');
  94         break;
  95
  96     case FR_NO_FILE:
  97         printf("It is not exist.\n");
  98         break;
  99
 100     default:
 101         printf("An error occured. (%d)\n", fr);
 102     }
 103 </pre>
 104 </div>
 105
 106
 107 <div class="para ref">
 108 <h4>References</h4>
 109 <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
 110 </div>
 111
 112 <p class="foot"><a href="../00index_e.html">Return</a></p>
 113 </body>
 114 </html>