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