projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="ja">\r | |
| 3 | <head>\r | |
| 7b78a5a2 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
5 | <meta http-equiv="Content-Style-Type" content="text/css">\r |
| 6 | <link rel="up" title="FatFs" href="../00index_j.html">\r | |
| 7 | <link rel="alternate" hreflang="en" title="English" href="../en/setlabel.html">\r | |
| 8 | <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_setlabel</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_setlabel</h2>\r | |
| 7b78a5a2 | 16 | <p>ボリュームにボリューム ラベルを設定します。</p>\r |
| 53668523 L |
17 | <pre>\r |
| 18 | FRESULT f_setlabel (\r | |
| 7b78a5a2 | 19 | const TCHAR* <span class="arg">label</span> <span class="c">/* [IN] 設定するボリューム ラベルへのポインタ */</span>\r |
| 53668523 L |
20 | );\r |
| 21 | </pre>\r | |
| 22 | </div>\r | |
| 23 | \r | |
| 24 | <div class="para arg">\r | |
| 7b78a5a2 | 25 | <h4>引数</h4>\r |
| 53668523 L |
26 | <dl class="par">\r |
| 27 | <dt>label</dt>\r | |
| 7b78a5a2 | 28 | <dd>設定するボリューム ラベルを示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。</dd>\r |
| 53668523 L |
29 | </dl>\r |
| 30 | </div>\r | |
| 31 | \r | |
| 32 | \r | |
| 33 | <div class="para ret">\r | |
| 7b78a5a2 | 34 | <h4>戻り値</h4>\r |
| 53668523 L |
35 | <p>\r |
| 36 | <a href="rc.html#ok">FR_OK</a>,\r | |
| 37 | <a href="rc.html#de">FR_DISK_ERR</a>,\r | |
| 38 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
| 39 | <a href="rc.html#nr">FR_NOT_READY</a>,\r | |
| 40 | <a href="rc.html#in">FR_INVALID_NAME</a>,\r | |
| 41 | <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,\r | |
| 42 | <a href="rc.html#id">FR_INVALID_DRIVE</a>,\r | |
| 43 | <a href="rc.html#ne">FR_NOT_ENABLED</a>,\r | |
| 44 | <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r | |
| 45 | <a href="rc.html#tm">FR_TIMEOUT</a>\r | |
| 46 | </p>\r | |
| 47 | </div>\r | |
| 48 | \r | |
| 49 | \r | |
| 50 | <div class="para desc">\r | |
| 7b78a5a2 L |
51 | <h4>解説</h4>\r |
| 52 | <p>文字列の先頭にドライブ番号を含む場合は、その論理ドライブに対して設定されます。含まない場合は、デフォルト ドライブに設定されます。ボリューム ラベルを削除するときは、ヌル文字列を指定します。ボリューム ラベルのフォーマットは、ファイル名(SFN)とほぼ同じですが、次の点が異なります。</p>\r | |
| 53668523 | 53 | <ul>\r |
| 7b78a5a2 L |
54 | <li>ローカル文字コード換算で11バイト以下。LFN拡張は適用されません。</li>\r |
| 55 | <li>ピリオドを含むことはできない。</li>\r | |
| 56 | <li>任意の位置にスペースを置くことができる。ただし、最後尾となるスペースは除去される。</li>\r | |
| 53668523 L |
57 | </ul>\r |
| 58 | </div>\r | |
| 59 | \r | |
| 60 | <div class="para comp">\r | |
| 7b78a5a2 L |
61 | <h4>対応情報</h4>\r |
| 62 | <p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_USE_LABEL == 1</tt>のときに使用可能です。</p>\r | |
| 53668523 L |
63 | </div>\r |
| 64 | \r | |
| 65 | \r | |
| 66 | <div class="para use">\r | |
| 7b78a5a2 | 67 | <h4>使用例</h4>\r |
| 53668523 | 68 | <pre>\r |
| 7b78a5a2 | 69 | <span class="c">/* デフォルト ドライブにボリューム ラベルを設定 */</span>\r |
| 53668523 L |
70 | f_setlabel("DATA DISK");\r |
| 71 | \r | |
| 7b78a5a2 | 72 | <span class="c">/* ドライブ2にボリューム ラベルを設定 */</span>\r |
| 53668523 L |
73 | f_setlabel("2:DISK 3 OF 4");\r |
| 74 | \r | |
| 7b78a5a2 | 75 | <span class="c">/* ドライブ2のボリューム ラベルを削除 */</span>\r |
| 53668523 L |
76 | f_setlabel("2:");\r |
| 77 | </pre>\r | |
| 78 | </div>\r | |
| 79 | \r | |
| 80 | \r | |
| 81 | <div class="para ref">\r | |
| 7b78a5a2 | 82 | <h4>参照</h4>\r |
| 53668523 L |
83 | <tt><a href="getlabel.html">f_getlabel</a></tt>\r |
| 84 | </div>\r | |
| 85 | \r | |
| 86 | \r | |
| 7b78a5a2 | 87 | <p class="foot"><a href="../00index_j.html">戻る</a></p>\r |
| 53668523 L |
88 | </body>\r |
| 89 | </html>\r |