getcwd.html 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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/getcwd.html">
  8. <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_getcwd</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_getcwd</h2>
  14. <p>The f_getcwd function retrieves the current directory and current drive.</p>
  15. <pre>
  16. FRESULT f_getcwd (
  17. TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span>
  18. UINT <span class="arg">len</span> <span class="c">/* [IN] The length of the buffer */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>buff</dt>
  26. <dd>Pointer to the buffer to receive the current directory string.</dd>
  27. <dt>len</dt>
  28. <dd>Size of the buffer in unit of <tt>TCHAR</tt>.</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#ne">FR_NOT_ENABLED</a>,
  39. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  40. <a href="rc.html#tm">FR_TIMEOUT</a>,
  41. <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  42. </p>
  43. </div>
  44. <div class="para desc">
  45. <h4>Description</h4>
  46. <p>The <tt>f_getcwd</tt> function retrieves full path name of the current directory of the current drive. When <tt>_VOLUMES</tt> is larger than 1, a logical drive number is added to top of the path name.</p>
  47. <p><em>Note: In this revision, this function cannot retrieve the current directory path on the exFAT volume. It always returns the root directory path.</em></p>
  48. </div>
  49. <div class="para comp">
  50. <h4>QuickInfo</h4>
  51. <p>Available when <tt>_FS_RPATH == 2</tt>.</p>
  52. </div>
  53. <div class="para ref">
  54. <h4>See Also</h4>
  55. <p><tt><a href="chdrive.html">f_chdrive</a>, <a href="chdir.html">f_chdir</a></tt></p>
  56. </div>
  57. <p class="foot"><a href="../00index_e.html">Return</a></p>
  58. </body>
  59. </html>