projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="en">\r | |
| 3 | <head>\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="alternate" hreflang="ja" title="Japanese" href="../ja/opendir.html">\r | |
| 8 | <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_opendir</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_opendir</h2>\r | |
| 16 | <p>The f_opendir function opens a directory.</p>\r | |
| 17 | <pre>\r | |
| 18 | FRESULT f_opendir (\r | |
| 19 | DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Pointer to the directory object structure */</span>\r | |
| 20 | const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span>\r | |
| 21 | );\r | |
| 22 | </pre>\r | |
| 23 | </div>\r | |
| 24 | \r | |
| 25 | <div class="para arg">\r | |
| 26 | <h4>Parameters</h4>\r | |
| 27 | <dl class="par">\r | |
| 28 | <dt>dp</dt>\r | |
| 29 | <dd>Pointer to the blank directory object to create a new one.</dd>\r | |
| 30 | <dt>path</dt>\r | |
| 70702af1 | 31 | <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>\r |
| 53668523 L |
32 | </dl>\r |
| 33 | </div>\r | |
| 34 | \r | |
| 35 | \r | |
| 36 | <div class="para ret">\r | |
| 37 | <h4>Return Values</h4>\r | |
| 38 | <p>\r | |
| 39 | <a href="rc.html#ok">FR_OK</a>,\r | |
| 40 | <a href="rc.html#de">FR_DISK_ERR</a>,\r | |
| 41 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
| 42 | <a href="rc.html#nr">FR_NOT_READY</a>,\r | |
| 43 | <a href="rc.html#np">FR_NO_PATH</a>,\r | |
| 44 | <a href="rc.html#in">FR_INVALID_NAME</a>,\r | |
| 45 | <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r | |
| 46 | <a href="rc.html#id">FR_INVALID_DRIVE</a>,\r | |
| 47 | <a href="rc.html#ne">FR_NOT_ENABLED</a>,\r | |
| 48 | <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r | |
| 49 | <a href="rc.html#tm">FR_TIMEOUT</a>,\r | |
| 50 | <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,\r | |
| 51 | <a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>\r | |
| 52 | </p>\r | |
| 53 | </div>\r | |
| 54 | \r | |
| 55 | \r | |
| 56 | <div class="para desc">\r | |
| 57 | <h4>Description</h4>\r | |
| 70702af1 | 58 | <p>The <tt>f_opendir</tt> function opens an exsisting directory and creates a directory object for subsequent <tt>f_readdir</tt> function.</p>\r |
| 53668523 L |
59 | </div>\r |
| 60 | \r | |
| 61 | \r | |
| 62 | <div class="para comp">\r | |
| 63 | <h4>QuickInfo</h4>\r | |
| 64 | <p>Available when <tt>_FS_MINIMIZE <= 1</tt>.</p>\r | |
| 65 | </div>\r | |
| 66 | \r | |
| 67 | \r | |
| 68 | <div class="para ref">\r | |
| 69 | <h4>See Also</h4>\r | |
| 70 | <p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a></tt></p>\r | |
| 71 | </div>\r | |
| 72 | \r | |
| 73 | <p class="foot"><a href="../00index_e.html">Return</a></p>\r | |
| 74 | </body>\r | |
| 75 | </html>\r |