closedir.html 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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/close.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_closedir</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_closedir</h2>
  14. <p>The f_closedir function closes an open directory.</p>
  15. <pre>
  16. FRESULT f_closedir (
  17. DIR* <span class="arg">dp</span> <span class="c">/* [IN] Pointer to the directory object */</span>
  18. );
  19. </pre>
  20. </div>
  21. <div class="para arg">
  22. <h4>Parameter</h4>
  23. <dl class="par">
  24. <dt>dp</dt>
  25. <dd>Pointer to the open directory object structure to be closed.</dd>
  26. </dl>
  27. </div>
  28. <div class="para ret">
  29. <h4>Return Values</h4>
  30. <p>
  31. <a href="rc.html#ok">FR_OK</a>,
  32. <a href="rc.html#ie">FR_INT_ERR</a>,
  33. <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  34. <a href="rc.html#tm">FR_TIMEOUT</a>
  35. </p>
  36. </div>
  37. <div class="para desc">
  38. <h4>Description</h4>
  39. <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>
  40. <p>Note that the directory object can also be discarded without this process when option <tt>_FS_LOCK</tt> is not enabled. However this is not recommended for future compatibility.</p>
  41. </div>
  42. <div class="para comp">
  43. <h4>QuickInfo</h4>
  44. <p>Available when <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>
  45. </div>
  46. <div class="para ref">
  47. <h4>See Also</h4>
  48. <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>
  49. </div>
  50. <p class="foot"><a href="../00index_e.html">Return</a></p>
  51. </body>
  52. </html>