]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/setlabel.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / documents / doc / setlabel.html
similarity index 59%
rename from fatfs/doc/en/setlabel.html
rename to fatfs/documents/doc/setlabel.html
index f7a8b0ebbbf0e8152e0a7514bc8487221be2f33d..c50db18ebaeb85fd6096a126ea2ddd98e5ec4364 100644 (file)
@@ -1,7 +1,7 @@
 <!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-Type" content="text/html; charset=utf-8">\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/setlabel.html">\r
@@ -49,19 +49,20 @@ FRESULT f_setlabel (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>When the string has a drive number, the volume label will be set to the volume specified by the drive number. If not, the volume label will be set to the default drive. If length of the given volume label is zero, the volume label on the volume will be removed. The format of the volume label on the FAT volume is similar to the file name but there are some differences shown below:</p>\r
+<p>When the string has a drive prefix, the volume label will be set to the volume specified by the drive prefix. Unix style volume ID cannot be used to specify the volume. If drive number is not specified, the volume label will be set to the default drive. If length of the given volume label is zero, the volume label on the volume will be removed. The format of the volume label is as shown below:</p>\r
 <ul>\r
-<li>Spaces can be contained anywhere in the volume label. Trailing spaces are truncated off at FAT volume.</li>\r
-<li>Period is not allowed.</li>\r
 <li>Up to 11 bytes long as conversion of OEM code page at FAT volume.</li>\r
-<li>Up to 11 characters long at exFAT volume. Case information is preserved.</li>\r
+<li>Up to 11 characters long at exFAT volume.</li>\r
+<li>Allowable characters for FAT volume are: <tt>! # $ % &amp; ' ( ) - ^ _ ` ~ { } 0-9 A-Z a-z</tt> and extended characters. Low-case characters are up converted.</li>\r
+<li>Allowable characters for exFAT volume are: characters allowed for FAT volume and <tt>" + , . ; = [ ]</tt>. Low-case characters are preserved.</li>\r
+<li>Spaces can be contained anywhere in the volume label. Trailing spaces are truncated off at FAT volume.</li>\r
 </ul>\r
-<p>Remark: The standard system (Windows) has a problem at handling of the volume label with a heading <tt>\xE5</tt> on the FAT volume. To avoid this problem, this function rejects such volume label as invalid name.</p>\r
+<p>Remark: The standard system (Windows) has a problem at the volume label with a heading <tt>\xE5</tt> on the FAT volume. To avoid this problem, this function rejects such volume label as invalid name.</p>\r
 </div>\r
 \r
 <div class="para comp">\r
 <h4>QuickInfo</h4>\r
-<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_USE_LABEL == 1</tt>.</p>\r
+<p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#use_label">FF_USE_LABEL</a> == 1</tt>.</p>\r
 </div>\r
 \r
 \r
@@ -69,13 +70,13 @@ FRESULT f_setlabel (
 <h4>Example</h4>\r
 <pre>\r
     <span class="c">/* Set volume label to the default drive */</span>\r
-    f_setlabel("DATA DISK");\r
+    <em>f_setlabel</em>("DATA DISK");\r
 \r
     <span class="c">/* Set volume label to the drive 2 */</span>\r
-    f_setlabel("2:DISK 3 OF 4");\r
+    <em>f_setlabel</em>("2:DISK 3 OF 4");\r
 \r
     <span class="c">/* Remove volume label of the drive 2 */</span>\r
-    f_setlabel("2:");\r
+    <em>f_setlabel</em>("2:");\r
 </pre>\r
 </div>\r
 \r