SetVolumeLabelA 関数 (winbase.h)

ファイル システム ボリュームのラベルを設定します。

構文

BOOL SetVolumeLabelA(
  [in, optional] LPCSTR lpRootPathName,
  [in, optional] LPCSTR lpVolumeName
);

パラメーター

[in, optional] lpRootPathName

ボリュームのドライブ文字 (X:など) またはボリュームに関連付けられているマウントされたフォルダーのパス (Y:\MountX など) を含む文字列へのポインター。 文字列の末尾に円記号 ('') を付けます。 このパラメーターが NULL場合は、現在のディレクトリのルートが使用されます。

[in, optional] lpVolumeName

ボリュームの新しいラベルを含む文字列へのポインター。 このパラメーターが NULL場合、関数は指定されたボリュームから既存のラベルを削除し、新しいラベルを割り当てません。

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError呼び出します。

備考

ボリューム・ラベルの最大長は 32 文字です。

FAT ファイルシステム: ボリューム ラベルの最大長は 11 文字です。

ラベルは、ユーザーが認識しやすくするためにボリュームに割り当てるわかりやすい名前です。 ボリュームには、ラベル、ドライブ文字、またはその両方を含めることができます。 詳細については、「ボリュームの名前付け を参照してください。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジー	サポート
サーバー メッセージ ブロック (SMB) 3.0 プロトコル	いいえ
SMB 3.0 透過的フェールオーバー (TFO)	いいえ
SMB 3.0 とスケールアウト ファイル共有 (SO)	いいえ
クラスター共有ボリューム ファイル システム (CsvFS)	はい
回復性のあるファイル システム (ReFS)	はい

 

SMB はボリューム管理機能をサポートしていません。

手記

winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetVolumeLabel を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー	Windows Server 2003 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	winbase.h (Windows.h を含む)
ライブラリ	Kernel32.lib
DLL	Kernel32.dll

関連項目

GetVolumeInformation の

ボリューム管理機能 の