Win32 API 日本語リファレンス
ホームStorage.FileSystem › SetVolumeLabelW

SetVolumeLabelW

関数
ボリュームのラベル名を設定する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetVolumeLabelW(
    LPCWSTR lpRootPathName,   // optional
    LPCWSTR lpVolumeName   // optional
);

パラメーター

名前方向説明
lpRootPathNameLPCWSTRinoptionalボリュームのドライブ文字(例: X:)、またはボリュームに関連付けられたマウントフォルダーのパス(例: Y:\MountX)を含む文字列へのポインター。文字列は末尾のバックスラッシュ('')で終わる必要があります。このパラメーターが NULL の場合、現在のディレクトリのルートが使用されます。
lpVolumeNameLPCWSTRinoptionalボリュームの新しいラベルを含む文字列へのポインター。このパラメーターが NULL の場合、関数は指定されたボリュームから既存のラベルを削除し、新しいラベルを割り当てません。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル なし
SMB 3.0 トランスペアレントフェールオーバー (TFO) なし
SMB 3.0 とスケールアウトファイル共有 (SO) なし
クラスター共有ボリュームファイルシステム (CsvFS) あり
Reliable File System (ReFS) あり

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

メモ

winbase.h ヘッダーは SetVolumeLabel を、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスと、エンコーディング非依存ではないコードを混在して使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetVolumeLabelW(
    LPCWSTR lpRootPathName,   // optional
    LPCWSTR lpVolumeName   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetVolumeLabelW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpRootPathName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpVolumeName   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetVolumeLabelW(
    <MarshalAs(UnmanagedType.LPWStr)> lpRootPathName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpVolumeName As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpRootPathName : LPCWSTR optional
' lpVolumeName : LPCWSTR optional
Declare PtrSafe Function SetVolumeLabelW Lib "kernel32" ( _
    ByVal lpRootPathName As LongPtr, _
    ByVal lpVolumeName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetVolumeLabelW = ctypes.windll.kernel32.SetVolumeLabelW
SetVolumeLabelW.restype = wintypes.BOOL
SetVolumeLabelW.argtypes = [
    wintypes.LPCWSTR,  # lpRootPathName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpVolumeName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetVolumeLabelW = Fiddle::Function.new(
  lib['SetVolumeLabelW'],
  [
    Fiddle::TYPE_VOIDP,  # lpRootPathName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpVolumeName : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn SetVolumeLabelW(
        lpRootPathName: *const u16,  // LPCWSTR optional
        lpVolumeName: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetVolumeLabelW([MarshalAs(UnmanagedType.LPWStr)] string lpRootPathName, [MarshalAs(UnmanagedType.LPWStr)] string lpVolumeName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetVolumeLabelW' -Namespace Win32 -PassThru
# $api::SetVolumeLabelW(lpRootPathName, lpVolumeName)
#uselib "KERNEL32.dll"
#func global SetVolumeLabelW "SetVolumeLabelW" wptr, wptr
; SetVolumeLabelW lpRootPathName, lpVolumeName   ; 戻り値は stat
; lpRootPathName : LPCWSTR optional -> "wptr"
; lpVolumeName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetVolumeLabelW "SetVolumeLabelW" wstr, wstr
; res = SetVolumeLabelW(lpRootPathName, lpVolumeName)
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpVolumeName : LPCWSTR optional -> "wstr"
; BOOL SetVolumeLabelW(LPCWSTR lpRootPathName, LPCWSTR lpVolumeName)
#uselib "KERNEL32.dll"
#cfunc global SetVolumeLabelW "SetVolumeLabelW" wstr, wstr
; res = SetVolumeLabelW(lpRootPathName, lpVolumeName)
; lpRootPathName : LPCWSTR optional -> "wstr"
; lpVolumeName : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetVolumeLabelW = kernel32.NewProc("SetVolumeLabelW")
)

// lpRootPathName (LPCWSTR optional), lpVolumeName (LPCWSTR optional)
r1, _, err := procSetVolumeLabelW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpRootPathName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpVolumeName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetVolumeLabelW(
  lpRootPathName: PWideChar;   // LPCWSTR optional
  lpVolumeName: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetVolumeLabelW';
result := DllCall("KERNEL32\SetVolumeLabelW"
    , "WStr", lpRootPathName   ; LPCWSTR optional
    , "WStr", lpVolumeName   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●SetVolumeLabelW(lpRootPathName, lpVolumeName) = DLL("KERNEL32.dll", "bool SetVolumeLabelW(char*, char*)")
# 呼び出し: SetVolumeLabelW(lpRootPathName, lpVolumeName)
# lpRootPathName : LPCWSTR optional -> "char*"
# lpVolumeName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn SetVolumeLabelW(
    lpRootPathName: [*c]const u16, // LPCWSTR optional
    lpVolumeName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetVolumeLabelW(
    lpRootPathName: WideCString,  # LPCWSTR optional
    lpVolumeName: WideCString  # LPCWSTR optional
): int32 {.importc: "SetVolumeLabelW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int SetVolumeLabelW(
    const(wchar)* lpRootPathName,   // LPCWSTR optional
    const(wchar)* lpVolumeName   // LPCWSTR optional
);
ccall((:SetVolumeLabelW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring),
      lpRootPathName, lpVolumeName)
# lpRootPathName : LPCWSTR optional -> Cwstring
# lpVolumeName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetVolumeLabelW(
    const uint16_t* lpRootPathName,
    const uint16_t* lpVolumeName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetVolumeLabelW(lpRootPathName, lpVolumeName)
-- lpRootPathName : LPCWSTR optional
-- lpVolumeName : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetVolumeLabelW = lib.func('__stdcall', 'SetVolumeLabelW', 'int32_t', ['str16', 'str16']);
// SetVolumeLabelW(lpRootPathName, lpVolumeName)
// lpRootPathName : LPCWSTR optional -> 'str16'
// lpVolumeName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetVolumeLabelW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.SetVolumeLabelW(lpRootPathName, lpVolumeName)
// lpRootPathName : LPCWSTR optional -> "buffer"
// lpVolumeName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetVolumeLabelW(
    const uint16_t* lpRootPathName,
    const uint16_t* lpVolumeName);
C, "KERNEL32.dll");
// $ffi->SetVolumeLabelW(lpRootPathName, lpVolumeName);
// lpRootPathName : LPCWSTR optional
// lpVolumeName : LPCWSTR optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetVolumeLabelW(
        WString lpRootPathName,   // LPCWSTR optional
        WString lpVolumeName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun SetVolumeLabelW = SetVolumeLabelW(
    lpRootPathName : UInt16*,   # LPCWSTR optional
    lpVolumeName : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetVolumeLabelWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef SetVolumeLabelWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final SetVolumeLabelW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetVolumeLabelWNative, SetVolumeLabelWDart>('SetVolumeLabelW');
// lpRootPathName : LPCWSTR optional -> Pointer<Utf16>
// lpVolumeName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetVolumeLabelW(
  lpRootPathName: PWideChar;   // LPCWSTR optional
  lpVolumeName: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetVolumeLabelW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetVolumeLabelW"
  c_SetVolumeLabelW :: CWString -> CWString -> IO CInt
-- lpRootPathName : LPCWSTR optional -> CWString
-- lpVolumeName : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setvolumelabelw =
  foreign "SetVolumeLabelW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpRootPathName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpVolumeName : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetVolumeLabelW" set-volume-label-w :convention :stdcall) :int32
  (lp-root-path-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-volume-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetVolumeLabelW = Win32::API::More->new('KERNEL32',
    'BOOL SetVolumeLabelW(LPCWSTR lpRootPathName, LPCWSTR lpVolumeName)');
# my $ret = $SetVolumeLabelW->Call($lpRootPathName, $lpVolumeName);
# lpRootPathName : LPCWSTR optional -> LPCWSTR
# lpVolumeName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目