diff options
Diffstat (limited to '3rdparty/fatfs-0.10b/doc/en/rename.html')
-rw-r--r-- | 3rdparty/fatfs-0.10b/doc/en/rename.html | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/3rdparty/fatfs-0.10b/doc/en/rename.html b/3rdparty/fatfs-0.10b/doc/en/rename.html new file mode 100644 index 00000000..e6f05232 --- /dev/null +++ b/3rdparty/fatfs-0.10b/doc/en/rename.html @@ -0,0 +1,85 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta http-equiv="Content-Style-Type" content="text/css"> +<link rel="up" title="FatFs" href="../00index_e.html"> +<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/rename.html"> +<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> +<title>FatFs - f_rename</title> +</head> + +<body> + +<div class="para func"> +<h2>f_rename</h2> +<p>Renames a file or sub-directory.</p> +<pre> +FRESULT f_rename ( + const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] Old object name */</span> + const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] New object name */</span> +); +</pre> +</div> + +<div class="para arg"> +<h4>Parameters</h4> +<dl class="par"> +<dt>old_name</dt> +<dd>Pointer to a null-terminated string that specifies an existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd> +<dt>new_name</dt> +<dd>Pointer to a null-terminated string that specifies the new object name. The drive number specified in this string is ignored and one determined by <tt class="arg">old_name</tt> is used instead.</dd> +</dl> +</div> + + +<div class="para ret"> +<h4>Return Values</h4> +<p> +<a href="rc.html#ok">FR_OK</a>, +<a href="rc.html#de">FR_DISK_ERR</a>, +<a href="rc.html#ie">FR_INT_ERR</a>, +<a href="rc.html#nr">FR_NOT_READY</a>, +<a href="rc.html#ok">FR_NO_FILE</a>, +<a href="rc.html#np">FR_NO_PATH</a>, +<a href="rc.html#in">FR_INVALID_NAME</a>, +<a href="rc.html#de">FR_DENIED</a>, +<a href="rc.html#ex">FR_EXIST</a>, +<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, +<a href="rc.html#id">FR_INVALID_DRIVE</a>, +<a href="rc.html#ne">FR_NOT_ENABLED</a>, +<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, +<a href="rc.html#tm">FR_TIMEOUT</a>, +<a href="rc.html#lo">FR_LOCKED</a>, +<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> +</p> +</div> + + +<div class="para desc"> +<h4>Description</h4> +<p>Renames a file or sub-directory and can also move it to other directory within the same logical drive. <em>Do not rename open objects</em> or directry table can be broken.</p> +</div> + + +<div class="para comp"> +<h4>QuickInfo</h4> +<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> +</div> + + +<div class="para use"> +<h4>Example</h4> +<pre> + <span class="c">/* Rename an object */</span> + f_rename("oldname.txt", "newname.txt"); + + <span class="c">/* Rename and move an object to other directory */</span> + f_rename("oldname.txt", "dir1/newname.txt"); +</pre> +</div> + + +<p class="foot"><a href="../00index_e.html">Return</a></p> +</body> +</html> |