Import fatfs R0.13b

[z180-stamp.git] / fatfs / documents / doc / getcwd.html
diff --git a/fatfs/doc/en/getcwd.html b/fatfs/documents/doc/getcwd.html

similarity index 70%

rename from fatfs/doc/en/getcwd.html

rename to fatfs/documents/doc/getcwd.html

index 52a7f3f895933f0b291aea47751ac57ea225b1a1..d5eab61cccf410b25ee4c8fbc5feb7b36661115f 100644 (file)
--- a/fatfs/doc/en/getcwd.html
+++ b/fatfs/documents/doc/getcwd.html
@@ -1,7 +1,7 @@
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
  <html lang="en">\r
  <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
  <meta http-equiv="Content-Style-Type" content="text/css">\r
  <link rel="up" title="FatFs" href="../00index_e.html">\r
  <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/getcwd.html">\r
@@ -13,7 +13,7 @@
  \r
  <div class="para func">\r
  <h2>f_getcwd</h2>\r
-<p>The f_getcwd function retrieves the current directory and current drive.</p>\r
+<p>The f_getcwd function retrieves the current directory of the current drive.</p>\r
  <pre>\r
  FRESULT f_getcwd (\r
    TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span>\r
@@ -50,14 +50,26 @@ FRESULT f_getcwd (
  \r
  <div class="para desc">\r
  <h4>Description</h4>\r
-<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>\r
+<p>The <tt>f_getcwd</tt> function retrieves full path name of the current directory of the current drive. When <tt><a href="config.html#volumes">FF_VOLUMES</a> &gt;= 2</tt>, a heading drive prefix is added to the path name. The style of drive prefix is depends on <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a></tt>.</p>\r
  <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>\r
  </div>\r
  \r
  \r
  <div class="para comp">\r
  <h4>QuickInfo</h4>\r
-<p>Available when <tt>_FS_RPATH == 2</tt>.</p>\r
+<p>Available when <tt><a href="config.html#fs_rpath">FF_FS_RPATH</a> == 2</tt>.</p>\r
+</div>\r
+\r
+\r
+<div class="para use">\r
+<h4>Example</h4>\r
+<pre>\r
+    FRESULT fr;\r
+    TCHAR str[SZ_STR];\r
+\r
+    fr = <em>f_getcwd</em>(str, SZ_STR);  <span class="c">/* Get current directory path */</span>\r
+\r
+</pre>\r
  </div>\r
  \r
  \r