getlabel.html 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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/getlabel.html">
  8. <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_getlabel</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_getlabel</h2>
  14. <p>ボリューム ラベルを取得します。</p>
  15. <pre>
  16. FRESULT f_getlabel (
  17. const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] 対象ドライブ */</span>
  18. TCHAR* <span class="arg">label</span>, <span class="c">/* [OUT] ボリューム名を格納するバッファ */</span>
  19. DWORD* <span class="arg">vsn</span> <span class="c">/* [OUT] ボリューム シリアル番号を格納する変数 */</span>
  20. );
  21. </pre>
  22. </div>
  23. <div class="para arg">
  24. <h4>引数</h4>
  25. <dl class="par">
  26. <dt>path</dt>
  27. <dd>対象となる論理ドライブの<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。ヌル文字列の場合は、デフォルト ドライブを指定したことになります。</dd>
  28. <dt>label</dt>
  29. <dd>ボリューム名を格納する配列へのポインタを指定します。<tt>_LFN_UNICODE == 0</tt>では少なくとも24要素、<tt>_LFN_UNICODE == 1</tt>では少なくとも12要素のサイズが必要です。ボリューム名がない場合はヌル文字列が返されます。この情報が不要なときはヌル ポインタを指定してください。</dd>
  30. <dt>vsn</dt>
  31. <dd>ボリューム シリアル番号を格納する<tt>DWORD</tt>型変数へのポインタを指定します。この情報が不要なときはヌル ポインタを指定してください。</dd>
  32. </dl>
  33. </div>
  34. <div class="para ret">
  35. <h4>戻り値</h4>
  36. <p>
  37. <a href="rc.html#ok">FR_OK</a>,
  38. <a href="rc.html#de">FR_DISK_ERR</a>,
  39. <a href="rc.html#ie">FR_INT_ERR</a>,
  40. <a href="rc.html#nr">FR_NOT_READY</a>,
  41. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  42. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  43. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  44. <a href="rc.html#tm">FR_TIMEOUT</a>
  45. </p>
  46. </div>
  47. <div class="para comp">
  48. <h4>対応情報</h4>
  49. <p><tt>_USE_LABEL == 1</tt>のときに使用可能です。</p>
  50. </div>
  51. <div class="para use">
  52. <h4>使用例</h4>
  53. <pre>
  54. char str[24];
  55. <span class="c">/* デフォルト ドライブのボリューム名を得る */</span>
  56. f_getlabel("", str, 0);
  57. <span class="c">/* ドライブ2のボリューム名を得る */</span>
  58. f_getlabel("2:", str, 0);
  59. </pre>
  60. </div>
  61. <div class="para ref">
  62. <h4>参照</h4>
  63. <tt><a href="setlabel.html">f_setlabel</a></tt>
  64. </div>
  65. <p class="foot"><a href="../00index_j.html">戻る</a></p>
  66. </body>
  67. </html>