FatFs - f_getlabel

## f_getlabel

ボリューム ラベルを取得します。

    FRESULT f_getlabel (
      const TCHAR* path,  /* [IN] 対象ドライブ */
      TCHAR* label,       /* [OUT] ボリューム名を格納するバッファ */
      DWORD* vsn          /* [OUT] ボリューム シリアル番号を格納する変数 */
    );

#### 引数

path
  対象となる論理ドライブのパス名を示すヌル文字`'\0'`終端の文字列へのポインタを指定します。ヌル文字列の場合は、デフォルト ドライブを指定したことになります。
label
  ボリューム名を格納する配列へのポインタを指定します。`_LFN_UNICODE == 0`では少なくとも24要素、`_LFN_UNICODE == 1`では少なくとも12要素のサイズが必要です。ボリューム名がない場合はヌル文字列が返されます。この情報が不要なときはヌル ポインタを指定してください。
vsn
  ボリューム シリアル番号を格納する`DWORD`型変数へのポインタを指定します。この情報が不要なときはヌル ポインタを指定してください。

#### 戻り値

FR_OK, FR_DISK_ERR, FR_INT_ERR, FR_NOT_READY, FR_INVALID_DRIVE, FR_NOT_ENABLED, FR_NO_FILESYSTEM, FR_TIMEOUT

#### 対応情報

`_USE_LABEL == 1`のときに使用可能です。

#### 使用例

        char str[24];

        /* デフォルト ドライブのボリューム名を得る */
        f_getlabel("", str, 0);

        /* ドライブ2のボリューム名を得る */
        f_getlabel("2:", str, 0);

#### 参照

`f_setlabel`

戻る