/wbudowane/mp3-wave/pff2/doc/pf/opendir.html

http://momus-projects.googlecode.com/ · HTML · 72 lines · 60 code · 12 blank · 0 comment · 0 complexity · 68ca82c4e3c34d96cc108775b1615ce2 MD5 · raw file

  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="Petit FatFs" href="../00index_p.html">
  7. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  8. <link rel="stylesheet" href="../css_p.css" type="text/css" media="screen" title="ELM Default">
  9. <title>Petit FatFs - pf_opendir</title>
  10. </head>
  11. <body>
  12. <div class="para">
  13. <h2>pf_opendir</h2>
  14. <p>The pf_opendir function opens a directory.</p>
  15. <pre>
  16. FRESULT pf_opendir (
  17. DIR* <em>DirObject</em>, /* Pointer to the blank directory object structure */
  18. const char* <em>DirName</em> /* Pointer to the directory name */
  19. );
  20. </pre>
  21. </div>
  22. <div class="para">
  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">
  32. <h4>Return Values</h4>
  33. <dl class="ret">
  34. <dt>FR_OK (0)</dt>
  35. <dd>The function succeeded and the directory object is created. It is used for subsequent calls to read the directory entries.</dd>
  36. <dt>FR_NO_PATH</dt>
  37. <dd>Could not find the path.</dd>
  38. <dt>FR_NOT_READY</dt>
  39. <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  40. <dt>FR_DISK_ERR</dt>
  41. <dd>The function failed due to an error in the disk function, a wrong FAT structure or an internal error.</dd>
  42. <dt>FR_NOT_ENABLED</dt>
  43. <dd>The volume has no work area.</dd>
  44. </dl>
  45. </div>
  46. <div class="para">
  47. <h4>Description</h4>
  48. <p>The pf_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>
  49. </div>
  50. <div class="para">
  51. <h4>QuickInfo</h4>
  52. <p>Available when <tt>_USE_DIR == 1</tt>.</p>
  53. </div>
  54. <div class="para">
  55. <h4>References</h4>
  56. <p><tt><a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>
  57. </div>
  58. <p class="foot"><a href="../00index_p.html">Return</a></p>
  59. </body>
  60. </html>