]> cloudbase.mooo.com Git - z180-stamp.git/blame - fatfs/doc/en/getcwd.html
Import fatfs R0.12b
[z180-stamp.git] / fatfs / doc / en / getcwd.html
CommitLineData
53668523
L
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
5<meta http-equiv="Content-Style-Type" content="text/css">\r
6<link rel="up" title="FatFs" href="../00index_e.html">\r
7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/getcwd.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - f_getcwd</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>f_getcwd</h2>\r
70702af1 16<p>The f_getcwd function retrieves the current directory and current drive.</p>\r
53668523
L
17<pre>\r
18FRESULT f_getcwd (\r
19 TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to return path name */</span>\r
20 UINT <span class="arg">len</span> <span class="c">/* [IN] The length of the buffer */</span>\r
21);\r
22</pre>\r
23</div>\r
24\r
25<div class="para arg">\r
26<h4>Parameters</h4>\r
27<dl class="par">\r
28<dt>buff</dt>\r
29<dd>Pointer to the buffer to receive the current directory string.</dd>\r
30<dt>len</dt>\r
7b78a5a2 31<dd>Size of the buffer in unit of <tt>TCHAR</tt>.</dd>\r
53668523
L
32</dl>\r
33</div>\r
34\r
35\r
36<div class="para ret">\r
37<h4>Return Values</h4>\r
38<p>\r
39<a href="rc.html#ok">FR_OK</a>,\r
40<a href="rc.html#de">FR_DISK_ERR</a>,\r
41<a href="rc.html#ie">FR_INT_ERR</a>,\r
42<a href="rc.html#nr">FR_NOT_READY</a>,\r
43<a href="rc.html#ne">FR_NOT_ENABLED</a>,\r
44<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r
45<a href="rc.html#tm">FR_TIMEOUT</a>,\r
46<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r
47</p>\r
48</div>\r
49\r
50\r
51<div class="para desc">\r
52<h4>Description</h4>\r
70702af1
L
53<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
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>\r
53668523
L
55</div>\r
56\r
57\r
58<div class="para comp">\r
59<h4>QuickInfo</h4>\r
60<p>Available when <tt>_FS_RPATH == 2</tt>.</p>\r
61</div>\r
62\r
63\r
64<div class="para ref">\r
65<h4>See Also</h4>\r
66<p><tt><a href="chdrive.html">f_chdrive</a>, <a href="chdir.html">f_chdir</a></tt></p>\r
67</div>\r
68\r
69<p class="foot"><a href="../00index_e.html">Return</a></p>\r
70</body>\r
71</html>\r