bertos/fs/fatfs/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>Rename file or directory.</p>\r
  16 <pre>\r
  17 FRESULT f_rename (\r
  18   const char* <em>OldName</em>, /* Pointer to old file/directory name */\r
  19   const char* <em>NewName</em>  /* Pointer to new file/directory 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">file/directory name</a> to be renamed.</dd>\r
  29 <dt>NewName</dt>\r
  30 <dd>Pointer to a null-terminated string specifies the new file/directory name without drive number. Existing object nannot be specified.</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>There is an object that have a name equal to new 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 partition 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>Rename a file or directory and can move it to other directory. Logical drive number is determined by old name, new name must not contain logical drive number. This function is not supported in read-only configuration or minimization level of &gt;= 1.</p>\r
  71 </div>\r
  72 \r
  73 \r
  74 <div class="para">\r
  75 <h4>Example</h4>\r
  76 <pre>\r
  77     // Rename a file or directory\r
  78     f_rename("oldname.txt", "newname.txt");\r
  79 \r
  80     // Rename and move a file or directory to other directory simultaneously\r
  81     f_rename("oldname.txt", "dir1/newname.txt");\r
  82 </pre>\r
  83 </div>\r
  84 \r
  85 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  86 </body>\r
  87 </html>\r