opendir.html 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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* <em>DirObject</em>, <span class="c">/* Pointer to the blank directory object structure */</span>
  18. const TCHAR* <em>DirName</em> <span class="c">/* Pointer to the directory name */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>DirObject</dt>
  26. <dd>Pointer to the blank directory object to be created.</dd>
  27. <dt>DirName</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#id">FR_INVALID_DRIVE</a>,
  41. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  42. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  43. <a href="rc.html#tm">FR_TIMEOUT</a>,
  44. <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  45. </p>
  46. </div>
  47. <div class="para desc">
  48. <h4>Description</h4>
  49. <p>The f_opendir function opens an exsisting directory and creates the directory object for subsequent calls. The directory object structure can be discarded at any time without any procedure.</p>
  50. </div>
  51. <div class="para comp">
  52. <h4>QuickInfo</h4>
  53. <p>Available when <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>
  54. </div>
  55. <div class="para ref">
  56. <h4>See Also</h4>
  57. <p><tt><a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>
  58. </div>
  59. <p class="foot"><a href="../00index_e.html">Return</a></p>
  60. </body>
  61. </html>