1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
\r
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
\r
5 <meta http-equiv="Content-Style-Type" content="text/css">
\r
6 <link rel="up" title="FatFs" href="../00index_e.html">
\r
7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
\r
8 <title>FatFs - f_readdir</title>
\r
15 <p>The f_readdir function reads directory entries.</p>
\r
18 DIR* <em>DirObject</em>, /* Pointer to the open directory object */
\r
19 FILINFO* <em>FileInfo</em> /* Pointer to the file information structure */
\r
28 <dd>Pointer to the open directory object.</dd>
\r
30 <dd>Pointer to the file information structure to store the read item.</dd>
\r
36 <h4>Return Values</h4>
\r
39 <dd>The function succeeded.</dd>
\r
40 <dt>FR_NOT_READY</dt>
\r
41 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
\r
42 <dt>FR_DISK_ERR</dt>
\r
43 <dd>The function failed due to an error in the disk function.</dd>
\r
45 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>
\r
46 <dt>FR_INVALID_OBJECT</dt>
\r
47 <dd>The directory object is invalid.</dd>
\r
53 <h4>Description</h4>
\r
54 <p>The f_readdir function reads directory entries in sequence. All items in the directory can be read by calling f_readdir function repeatedly. When all directory items have been read and no item to read, the function returns a null string into <tt>f_name[]</tt> member without any error. When a null pointer is given to the <tt>FileInfo</tt>, the read index of the directory object will be rewinded.</p>
\r
55 <p>When LFN feature is enabled, <tt>lfname</tt> and <tt>lfsize</tt> in the file information structure must be initialized with valid value prior to calling the f_readdir function. The <tt>lfname</tt> is a pointer to the string buffer to return the long file name. The <tt>lfsize</tt> is the size of the string buffer. When either the size of specified buffer or LFN working buffer is insufficient to store the LFN or LFN is not exist, a null string will be returned. When <tt>lfname</tt> is a NULL, nothing is returned.</p>
\r
56 <p>For details on the file informations, refer to the <tt>FILINFO</tt>. This function is not supported in minimization level of >=2.</p>
\r
61 <h4>Sample Code</h4>
\r
63 FRESULT scan_files (char* path)
\r
71 static char lfn[_MAX_LFN * (_DF1S ? 2 : 1) + 1];
\r
73 fno.lfsize = sizeof(lfn);
\r
77 res = f_opendir(&dir, path);
\r
81 res = f_readdir(&dir, &fno);
\r
82 if (res != FR_OK || fno.fname[0] == 0) break;
\r
84 fn = *fno.lfname ? fno.lfname : fno.fname;
\r
88 if (fno.fattrib & AM_DIR) {
\r
89 sprintf(&path[i], "/%s", fn);
\r
90 res = scan_files(path);
\r
91 if (res != FR_OK) break;
\r
94 printf("%s/%s\n", path, fn);
\r
106 <h4>References</h4>
\r
107 <p><tt><a href="opendir.html">f_opendir</a>, <a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a>, <a href="sdir.html">DIR</a></tt></p>
\r
110 <p class="foot"><a href="../00index_e.html">Return</a></p>
\r