FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/utime.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=iso-8859-1">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_e.html">
   7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   8 <title>FatFs - f_utime</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_utime</h2>
  15 <p>The f_utime function changes the timestamp of a file or directory.</p>
  16 <pre>
  17 FRESULT f_utime (
  18   const XCHAR* <em>FileName</em>,   /* Pointer to the file or directory path */
  19   const FILINFO* <em>TimeDate</em>  /* Time and data to be set */
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para">
  25 <h4>Parameters</h4>
  26 <dl class="par">
  27 <dt>FileName</dt>
  28 <dd>Pointer to the null-terminated string that specifies a <a href="filename.html">file or directory</a> to be changed.</dd>
  29 <dt>TimeDate</dt>
  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>
  31 </dl>
  32 </div>
  33
  34
  35 <div class="para">
  36 <h4>Return Values</h4>
  37 <dl class="ret">
  38 <dt>FR_OK (0)</dt>
  39 <dd>The function succeeded.</dd>
  40 <dt>FR_NO_FILE</dt>
  41 <dd>Could not find the file.</dd>
  42 <dt>FR_NO_PATH</dt>
  43 <dd>Could not find the path.</dd>
  44 <dt>FR_INVALID_NAME</dt>
  45 <dd>The file name is invalid.</dd>
  46 <dt>FR_INVALID_DRIVE</dt>
  47 <dd>The drive number is invalid.</dd>
  48 <dt>FR_NOT_READY</dt>
  49 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  50 <dt>FR_WRITE_PROTECTED</dt>
  51 <dd>The medium is write protected.</dd>
  52 <dt>FR_DISK_ERR</dt>
  53 <dd>The function failed due to an error in the disk function.</dd>
  54 <dt>FR_INT_ERR</dt>
  55 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>
  56 <dt>FR_NOT_ENABLED</dt>
  57 <dd>The logical drive has no work area.</dd>
  58 <dt>FR_NO_FILESYSTEM</dt>
  59 <dd>There is no valid FAT volume on the disk.</dd>
  60 </dl>
  61 </div>
  62
  63
  64 <div class="para">
  65 <h4>Description</h4>
  66 <p>The f_utime function changes the timestamp of a file or directory</p>
  67 </div>
  68
  69
  70 <div class="para">
  71 <h4>QuickInfo</h4>
  72 <p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
  73 </div>
  74
  75
  76 <div class="para">
  77 <h4>See Also</h4>
  78 <p><tt><a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
  79 </div>
  80
  81 <p class="foot"><a href="../00index_e.html">Return</a></p>
  82 </body>
  83 </html>