opendir.html 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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/opendir.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_opendir</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_opendir</h2>
  14. <p>The f_opendir function opens a directory.</p>
  15. <pre>
  16. FRESULT f_opendir (
  17. DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Pointer to the directory object structure */</span>
  18. const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>dp</dt>
  26. <dd>Pointer to the blank directory object to create a new one.</dd>
  27. <dt>path</dt>
  28. <dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
  29. </dl>
  30. </div>
  31. <div class="para ret">
  32. <h4>Return Values</h4>
  33. <p>
  34. <a href="rc.html#ok">FR_OK</a>,
  35. <a href="rc.html#de">FR_DISK_ERR</a>,
  36. <a href="rc.html#ie">FR_INT_ERR</a>,
  37. <a href="rc.html#nr">FR_NOT_READY</a>,
  38. <a href="rc.html#np">FR_NO_PATH</a>,
  39. <a href="rc.html#in">FR_INVALID_NAME</a>,
  40. <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  41. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  42. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  43. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  44. <a href="rc.html#tm">FR_TIMEOUT</a>,
  45. <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,
  46. <a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>
  47. </p>
  48. </div>
  49. <div class="para desc">
  50. <h4>Description</h4>
  51. <p>The <tt>f_opendir()</tt> function opens an exsisting directory and creates a directory object for subsequent <tt>f_readdir()</tt> function.</p>
  52. </div>
  53. <div class="para comp">
  54. <h4>QuickInfo</h4>
  55. <p>Available when <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>
  56. </div>
  57. <div class="para ref">
  58. <h4>See Also</h4>
  59. <p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a></tt></p>
  60. </div>
  61. <p class="foot"><a href="../00index_e.html">Return</a></p>
  62. </body>
  63. </html>