fatfs/doc/ja/setlabel.html

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