setlabel.html 2.6 KB

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