git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/FileSystem/FatFs-0.7e/doc/en/rename.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_rename</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 \r
  13 <div class="para">\r
  14 <h2>f_rename</h2>\r
  15 <p>Renames an object.</p>\r
  16 <pre>\r
  17 FRESULT f_rename (\r
  18   const XCHAR* <em>OldName</em>, /* Pointer to old object name */\r
  19   const XCHAR* <em>NewName</em>  /* Pointer to new object name */\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>OldName</dt>\r
  28 <dd>Pointer to a null-terminated string specifies the old <a href="filename.html">object name</a> to be renamed.</dd>\r
  29 <dt>NewName</dt>\r
  30 <dd>Pointer to a null-terminated string specifies the new object name without drive number.</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 old name.</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_EXIST</dt>\r
  51 <dd>The new name is colliding with an existing name.</dd>\r
  52 <dt>FR_DENIED</dt>\r
  53 <dd>The new name could not be created due to any reason.</dd>\r
  54 <dt>FR_WRITE_PROTECTED</dt>\r
  55 <dd>The medium is write protected.</dd>\r
  56 <dt>FR_DISK_ERR</dt>\r
  57 <dd>The function failed due to an error in the disk function.</dd>\r
  58 <dt>FR_INT_ERR</dt>\r
  59 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>\r
  60 <dt>FR_NOT_ENABLED</dt>\r
  61 <dd>The logical drive has no work area.</dd>\r
  62 <dt>FR_NO_FILESYSTEM</dt>\r
  63 <dd>There is no valid FAT volume on the disk.</dd>\r
  64 </dl>\r
  65 </div>\r
  66 \r
  67 \r
  68 <div class="para">\r
  69 <h4>Description</h4>\r
  70 <p>Renames an object and can also move it to other directory. The logical drive number is determined by old name, new name must not contain a logical drive number. <em>Do not rename open objects</em>.</p>\r
  71 </div>\r
  72 \r
  73 \r
  74 <div class="para">\r
  75 <h4>QuickInfo</h4>\r
  76 <p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>\r
  77 </div>\r
  78 \r
  79 \r
  80 <div class="para">\r
  81 <h4>Example</h4>\r
  82 <pre>\r
  83     /* Rename an object */\r
  84     f_rename("oldname.txt", "newname.txt");\r
  85 \r
  86     /* Rename and move an object to other directory */\r
  87     f_rename("oldname.txt", "dir1/newname.txt");\r
  88 </pre>\r
  89 </div>\r
  90 \r
  91 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  92 </body>\r
  93 </html>\r