SetVolumeLabelW 関数 (winbase.h)

  • [アーティクル]

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

構文

BOOL SetVolumeLabelW(
  [in, optional] LPCWSTR lpRootPathName,
  [in, optional] LPCWSTR 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 Transparent Failover (TFO) いいえ
スケールアウト ファイル共有 (SO) を使う SMB 3.0 いいえ
クラスターの共有ボリューム ファイル システム (CsvFS) はい
Resilient File System (ReFS) はい
 

SMB では、ボリューム管理機能はサポートされていません。

注意

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

要件

要件 値
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

GetVolumeInformation

ボリューム管理の関数