fatfs/documents/doc/getcwd.html

   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=utf-8">
   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
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_getcwd</h2>
  16 <p>The f_getcwd function retrieves the current directory of the current drive.</p>
  17 <pre>
  18 FRESULT f_getcwd (
  19   TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span>
  20   UINT <span class="arg">len</span>     <span class="c">/* [IN] The length of the buffer */</span>
  21 );
  22 </pre>
  23 </div>
  24
  25 <div class="para arg">
  26 <h4>Parameters</h4>
  27 <dl class="par">
  28 <dt>buff</dt>
  29 <dd>Pointer to the buffer to receive the current directory string.</dd>
  30 <dt>len</dt>
  31 <dd>Size of the buffer in unit of <tt>TCHAR</tt>.</dd>
  32 </dl>
  33 </div>
  34
  35
  36 <div class="para ret">
  37 <h4>Return Values</h4>
  38 <p>
  39 <a href="rc.html#ok">FR_OK</a>,
  40 <a href="rc.html#de">FR_DISK_ERR</a>,
  41 <a href="rc.html#ie">FR_INT_ERR</a>,
  42 <a href="rc.html#nr">FR_NOT_READY</a>,
  43 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  44 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  45 <a href="rc.html#tm">FR_TIMEOUT</a>,
  46 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  47 </p>
  48 </div>
  49
  50
  51 <div class="para desc">
  52 <h4>Description</h4>
  53 <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>
  54 <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>
  55 </div>
  56
  57
  58 <div class="para comp">
  59 <h4>QuickInfo</h4>
  60 <p>Available when <tt><a href="config.html#fs_rpath">FF_FS_RPATH</a> == 2</tt>.</p>
  61 </div>
  62
  63
  64 <div class="para use">
  65 <h4>Example</h4>
  66 <pre>
  67     FRESULT fr;
  68     TCHAR str[SZ_STR];
  69
  70     fr = <em>f_getcwd</em>(str, SZ_STR);  <span class="c">/* Get current directory path */</span>
  71
  72 </pre>
  73 </div>
  74
  75
  76 <div class="para ref">
  77 <h4>See Also</h4>
  78 <p><tt><a href="chdrive.html">f_chdrive</a>, <a href="chdir.html">f_chdir</a></tt></p>
  79 </div>
  80
  81 <p class="foot"><a href="../00index_e.html">Return</a></p>
  82 </body>
  83 </html>