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