Add FatFs module by ChaN.
[bertos.git] / bertos / fs / fatfs / doc / en / utime.html
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="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
8 <title>FatFs - f_utime</title>\r
9 </head>\r
10 \r
11 <body>\r
12 \r
13 <div class="para">\r
14 <h2>f_utime</h2>\r
15 <p>The f_utime function changes the timestamp of a file or directory.</p>\r
16 <pre>\r
17 FRESULT f_utime (\r
18   const char* <em>FileName</em>,    /* Pointer to the file or directory path */\r
19   const FILINFO* <em>TimeDate</em>  /* Time and data to be set */\r
20 );\r
21 </pre>\r
22 </div>\r
23 \r
24 <div class="para">\r
25 <h4>Parameters</h4>\r
26 <dl class="par">\r
27 <dt>FileName</dt>\r
28 <dd>Pointer to the null-terminated string that specifies a <a href="filename.html">file or directory</a> to be changed.</dd>\r
29 <dt>TimeDate</dt>\r
30 <dd>Pointer to the file information structure that has a timestamp to be set in member fdate and ftime. Do not care any other members.</dd>\r
31 </dl>\r
32 </div>\r
33 \r
34 \r
35 <div class="para">\r
36 <h4>Return Values</h4>\r
37 <dl class="ret">\r
38 <dt>FR_OK (0)</dt>\r
39 <dd>The function succeeded.</dd>\r
40 <dt>FR_NO_FILE</dt>\r
41 <dd>Could not find the file.</dd>\r
42 <dt>FR_NO_PATH</dt>\r
43 <dd>Could not find the path.</dd>\r
44 <dt>FR_INVALID_NAME</dt>\r
45 <dd>The file name is invalid.</dd>\r
46 <dt>FR_INVALID_DRIVE</dt>\r
47 <dd>The drive number is invalid.</dd>\r
48 <dt>FR_NOT_READY</dt>\r
49 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>\r
50 <dt>FR_WRITE_PROTECTED</dt>\r
51 <dd>The medium is write protected.</dd>\r
52 <dt>FR_DISK_ERR</dt>\r
53 <dd>The function failed due to an error in the disk function.</dd>\r
54 <dt>FR_INT_ERR</dt>\r
55 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>\r
56 <dt>FR_NOT_ENABLED</dt>\r
57 <dd>The logical drive has no work area.</dd>\r
58 <dt>FR_NO_FILESYSTEM</dt>\r
59 <dd>There is no valid FAT partition on the disk.</dd>\r
60 </dl>\r
61 </div>\r
62 \r
63 \r
64 <div class="para">\r
65 <h4>Description</h4>\r
66 <p>The f_utime function changes the timestamp of a file or directory. This function is not supported in read-only configuration and minimization level of &gt;=1.</p>\r
67 </div>\r
68 \r
69 \r
70 <div class="para">\r
71 <h4>References</h4>\r
72 <p><tt><a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>\r
73 </div>\r
74 \r
75 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
76 </body>\r
77 </html>\r