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 | |
| 289f6a14 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
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/close.html">\r | |
| 8 | <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_closedir</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_closedir</h2>\r | |
| 16 | <p>The f_closedir function closes an open directory.</p>\r | |
| 17 | <pre>\r | |
| 18 | FRESULT f_closedir (\r | |
| 19 | DIR* <span class="arg">dp</span> <span class="c">/* [IN] Pointer to the directory object */</span>\r | |
| 20 | );\r | |
| 21 | </pre>\r | |
| 22 | </div>\r | |
| 23 | \r | |
| 24 | <div class="para arg">\r | |
| 25 | <h4>Parameter</h4>\r | |
| 26 | <dl class="par">\r | |
| 27 | <dt>dp</dt>\r | |
| 28 | <dd>Pointer to the open directory object structure to be closed.</dd>\r | |
| 29 | </dl>\r | |
| 30 | </div>\r | |
| 31 | \r | |
| 32 | \r | |
| 33 | <div class="para ret">\r | |
| 34 | <h4>Return Values</h4>\r | |
| 35 | <p>\r | |
| 36 | <a href="rc.html#ok">FR_OK</a>,\r | |
| 37 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
| 38 | <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r | |
| 39 | <a href="rc.html#tm">FR_TIMEOUT</a>\r | |
| 40 | </p>\r | |
| 41 | </div>\r | |
| 42 | \r | |
| 43 | \r | |
| 44 | <div class="para desc">\r | |
| 45 | <h4>Description</h4>\r | |
| 70702af1 | 46 | <p>The <tt>f_closedir</tt> function closes an open directory object. After the function succeeded, the directory object is no longer valid and it can be discarded.</p>\r |
| 289f6a14 | 47 | <p>Note that the directory object can also be discarded without this procedure when option <tt>FF_FS_LOCK</tt> is not enabled. However this is not recommended for future compatibility.</p>\r |
| 53668523 L |
48 | </div>\r |
| 49 | \r | |
| 50 | \r | |
| 51 | <div class="para comp">\r | |
| 52 | <h4>QuickInfo</h4>\r | |
| 289f6a14 | 53 | <p>Available when <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> <= 1</tt>.</p>\r |
| 53668523 L |
54 | </div>\r |
| 55 | \r | |
| 56 | \r | |
| 57 | <div class="para ref">\r | |
| 58 | <h4>See Also</h4>\r | |
| 59 | <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>\r | |
| 60 | </div>\r | |
| 61 | \r | |
| 62 | <p class="foot"><a href="../00index_e.html">Return</a></p>\r | |
| 63 | </body>\r | |
| 64 | </html>\r |