/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. 

  2. <html lang="en">

    3. 

  3. <head>

    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

    5. 

  5. <meta http-equiv="Content-Style-Type" content="text/css">

    6. 

  6. <link rel="up" title="Petit FatFs" href="../00index_p.html">

    7. 

  7. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">

    8. 

  8. <link rel="stylesheet" href="../css_p.css" type="text/css" media="screen" title="ELM Default">

    9. 

  9. <title>Petit FatFs - pf_opendir</title>

    10. 

  10. </head>

    11. 

  11. 

    12. 

  12. <body>

    13. 

  13. 

    14. 

  14. <div class="para">

    15. 

  15. <h2>pf_opendir</h2>

    16. 

  16. <p>The pf_opendir function opens a directory.</p>

    17. 

  17. <pre>

    18. 

  18. FRESULT pf_opendir (

    19. 

  19.   DIR* <em>DirObject</em>,      /* Pointer to the blank directory object structure */

    20. 

  20.   const char* <em>DirName</em>  /* Pointer to the directory name */

    21. 

  21. );

    22. 

  22. </pre>

    23. 

  23. </div>

    24. 

  24. 

    25. 

  25. <div class="para">

    26. 

  26. <h4>Parameters</h4>

    27. 

  27. <dl class="par">

    28. 

  28. <dt>DirObject</dt>

    29. 

  29. <dd>Pointer to the blank directory object to be created.</dd>

    30. 

  30. <dt>DirName</dt>

    31. 

  31. <dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>

    32. 

  32. </dl>

    33. 

  33. </div>

    34. 

  34. 

    35. 

  35. 

    36. 

  36. <div class="para">

    37. 

  37. <h4>Return Values</h4>

    38. 

  38. <dl class="ret">

    39. 

  39. <dt>FR_OK (0)</dt>

    40. 

  40. <dd>The function succeeded and the directory object is created. It is used for subsequent calls to read the directory entries.</dd>

    41. 

  41. <dt>FR_NO_PATH</dt>

    42. 

  42. <dd>Could not find the path.</dd>

    43. 

  43. <dt>FR_NOT_READY</dt>

    44. 

  44. <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>

    45. 

  45. <dt>FR_DISK_ERR</dt>

    46. 

  46. <dd>The function failed due to an error in the disk function, a wrong FAT structure or an internal error.</dd>

    47. 

  47. <dt>FR_NOT_ENABLED</dt>

    48. 

  48. <dd>The volume has no work area.</dd>

    49. 

  49. </dl>

    50. 

  50. </div>

    51. 

  51. 

    52. 

  52. 

    53. 

  53. <div class="para">

    54. 

  54. <h4>Description</h4>

    55. 

  55. <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>

    56. 

  56. </div>

    57. 

  57. 

    58. 

  58. 

    59. 

  59. <div class="para">

    60. 

  60. <h4>QuickInfo</h4>

    61. 

  61. <p>Available when <tt>_USE_DIR == 1</tt>.</p>

    62. 

  62. </div>

    63. 

  63. 

    64. 

  64. 

    65. 

  65. <div class="para">

    66. 

  66. <h4>References</h4>

    67. 

  67. <p><tt><a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>

    68. 

  68. </div>

    69. 

  69. 

    70. 

  70. <p class="foot"><a href="../00index_p.html">Return</a></p>

    71. 

  71. </body>

    72. 

  72. </html>
    73.