]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/rename.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / doc / en / rename.html
diff --git a/fatfs/doc/en/rename.html b/fatfs/doc/en/rename.html
deleted file mode 100644 (file)
index 10cb4fd..0000000
+++ /dev/null
@@ -1,88 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
-<html lang="en">\r
-<head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
-<meta http-equiv="Content-Style-Type" content="text/css">\r
-<link rel="up" title="FatFs" href="../00index_e.html">\r
-<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/rename.html">\r
-<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
-<title>FatFs - f_rename</title>\r
-</head>\r
-\r
-<body>\r
-\r
-<div class="para func">\r
-<h2>f_rename</h2>\r
-<p>The f_rename function renames and/or moves a file or sub-directory.</p>\r
-<pre>\r
-FRESULT f_rename (\r
-  const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] Old object name */</span>\r
-  const TCHAR* <span class="arg">new_name</span>  <span class="c">/* [IN] New object name */</span>\r
-);\r
-</pre>\r
-</div>\r
-\r
-<div class="para arg">\r
-<h4>Parameters</h4>\r
-<dl class="par">\r
-<dt>old_name</dt>\r
-<dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd>\r
-<dt>new_name</dt>\r
-<dd>Pointer to a null-terminated string that specifies the new object name. A drive number may be specified in this string but it is ignored and assumed as the same drive of the <tt class="arg">old_name</tt>. Any object with this path name except <tt class="arg">old_name</tt> must not be exist, or the function fails with <tt>FR_EXIST</tt>.</dd>\r
-</dl>\r
-</div>\r
-\r
-\r
-<div class="para ret">\r
-<h4>Return Values</h4>\r
-<p>\r
-<a href="rc.html#ok">FR_OK</a>,\r
-<a href="rc.html#de">FR_DISK_ERR</a>,\r
-<a href="rc.html#ie">FR_INT_ERR</a>,\r
-<a href="rc.html#nr">FR_NOT_READY</a>,\r
-<a href="rc.html#ok">FR_NO_FILE</a>,\r
-<a href="rc.html#np">FR_NO_PATH</a>,\r
-<a href="rc.html#in">FR_INVALID_NAME</a>,\r
-<a href="rc.html#de">FR_DENIED</a>,\r
-<a href="rc.html#ex">FR_EXIST</a>,\r
-<a href="rc.html#wp">FR_WRITE_PROTECTED</a>,\r
-<a href="rc.html#id">FR_INVALID_DRIVE</a>,\r
-<a href="rc.html#ne">FR_NOT_ENABLED</a>,\r
-<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r
-<a href="rc.html#tm">FR_TIMEOUT</a>,\r
-<a href="rc.html#lo">FR_LOCKED</a>,\r
-<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r
-</p>\r
-</div>\r
-\r
-\r
-<div class="para desc">\r
-<h4>Description</h4>\r
-<p>Renames a file or sub-directory and can also move it to other directory in the same volume. The object to be renamed must not be an open object, or <em>the FAT volume can be collapsed</em>. Such the wrong operation is rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</p>\r
-</div>\r
-\r
-\r
-<div class="para comp">\r
-<h4>QuickInfo</h4>\r
-<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>\r
-</div>\r
-\r
-\r
-<div class="para use">\r
-<h4>Example</h4>\r
-<pre>\r
-    <span class="c">/* Rename an object in the default drive */</span>\r
-    f_rename("oldname.txt", "newname.txt");\r
-\r
-    <span class="c">/* Rename an object in the drive 2 */</span>\r
-    f_rename("2:oldname.txt", "newname.txt");\r
-\r
-    <span class="c">/* Rename an object and move it to other directory in the volume */</span>\r
-    f_rename("log.txt", "old/log0001.txt");\r
-</pre>\r
-</div>\r
-\r
-\r
-<p class="foot"><a href="../00index_e.html">Return</a></p>\r
-</body>\r
-</html>\r