111 lines
3.6 KiB
HTML
111 lines
3.6 KiB
HTML
<!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="up" title="FatFs" href="../00index_e.html">
|
|
<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/stat.html">
|
|
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_stat</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para func">
|
|
<h2>f_stat</h2>
|
|
<p>The f_stat function checks the existence of a file or sub-directory.</p>
|
|
<pre>
|
|
FRESULT f_stat (
|
|
const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Object name */</span>
|
|
FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] FILINFO structure */</span>
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para arg">
|
|
<h4>Parameters</h4>
|
|
<dl class="par">
|
|
<dt>path</dt>
|
|
<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">object</a> to get its information. The object must not be the root direcotry.</dd>
|
|
<dt>fno</dt>
|
|
<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>
|
|
</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#nr">FR_NOT_READY</a>,
|
|
<a href="rc.html#ok">FR_NO_FILE</a>,
|
|
<a href="rc.html#np">FR_NO_PATH</a>,
|
|
<a href="rc.html#in">FR_INVALID_NAME</a>,
|
|
<a href="rc.html#id">FR_INVALID_DRIVE</a>,
|
|
<a href="rc.html#ne">FR_NOT_ENABLED</a>,
|
|
<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
|
|
<a href="rc.html#tm">FR_TIMEOUT</a>,
|
|
<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
<div class="para desc">
|
|
<h4>Description</h4>
|
|
<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 about the object, size, timestamp and attribute, is 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>
|
|
</div>
|
|
|
|
|
|
<div class="para comp">
|
|
<h4>QuickInfo</h4>
|
|
<p>Available when <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> == 0</tt>.</p>
|
|
</div>
|
|
|
|
|
|
<div class="para use">
|
|
<h4>Example</h4>
|
|
<pre>
|
|
FRESULT fr;
|
|
FILINFO fno;
|
|
|
|
|
|
printf("Test for 'file.txt'...\n");
|
|
|
|
fr = f_stat("file.txt", &fno);
|
|
switch (fr) {
|
|
|
|
case FR_OK:
|
|
printf("Size: %lu\n", fno.fsize);
|
|
printf("Timestamp: %u/%02u/%02u, %02u:%02u\n",
|
|
(fno.fdate >> 9) + 1980, fno.fdate >> 5 & 15, fno.fdate & 31,
|
|
fno.ftime >> 11, fno.ftime >> 5 & 63);
|
|
printf("Attributes: %c%c%c%c%c\n",
|
|
(fno.fattrib & AM_DIR) ? 'D' : '-',
|
|
(fno.fattrib & AM_RDO) ? 'R' : '-',
|
|
(fno.fattrib & AM_HID) ? 'H' : '-',
|
|
(fno.fattrib & AM_SYS) ? 'S' : '-',
|
|
(fno.fattrib & AM_ARC) ? 'A' : '-');
|
|
break;
|
|
|
|
case FR_NO_FILE:
|
|
printf("It is not exist.\n");
|
|
break;
|
|
|
|
default:
|
|
printf("An error occured. (%d)\n", fr);
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="para ref">
|
|
<h4>References</h4>
|
|
<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_e.html">Return</a></p>
|
|
</body>
|
|
</html>
|