ホーム › Storage.FileSystem › SetVolumeLabelA
SetVolumeLabelA
関数ボリュームのラベル名を設定する(ANSI版)。
シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetVolumeLabelA(
LPCSTR lpRootPathName, // optional
LPCSTR lpVolumeName // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpRootPathName | LPCSTR | inoptional | ボリュームのドライブ文字(例: X:)、またはボリュームに関連付けられたマウントフォルダーのパス (例: Y:\MountX)を含む文字列へのポインター。文字列は末尾のバックスラッシュ('')で 終わる必要があります。このパラメーターが NULL の場合、現在のディレクトリの ルートが使用されます。 |
| lpVolumeName | LPCSTR | inoptional | ボリュームの新しいラベルを含む文字列へのポインター。このパラメーターが NULL の場合、関数は指定されたボリュームから既存のラベルを削除し、新しいラベルを 割り当てません。 |
戻り値の型: BOOL
公式ドキュメント
ファイルシステムボリュームのラベルを設定します。(ANSI)
戻り値
関数が成功した場合、戻り値は 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) | はい |
| 回復性のあるファイルシステム (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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL SetVolumeLabelA(
LPCSTR lpRootPathName, // optional
LPCSTR lpVolumeName // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetVolumeLabelA(
[MarshalAs(UnmanagedType.LPStr)] string lpRootPathName, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string lpVolumeName // LPCSTR optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetVolumeLabelA(
<MarshalAs(UnmanagedType.LPStr)> lpRootPathName As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> lpVolumeName As String ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpRootPathName : LPCSTR optional
' lpVolumeName : LPCSTR optional
Declare PtrSafe Function SetVolumeLabelA Lib "kernel32" ( _
ByVal lpRootPathName As String, _
ByVal lpVolumeName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetVolumeLabelA = ctypes.windll.kernel32.SetVolumeLabelA
SetVolumeLabelA.restype = wintypes.BOOL
SetVolumeLabelA.argtypes = [
wintypes.LPCSTR, # lpRootPathName : LPCSTR optional
wintypes.LPCSTR, # lpVolumeName : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetVolumeLabelA = Fiddle::Function.new(
lib['SetVolumeLabelA'],
[
Fiddle::TYPE_VOIDP, # lpRootPathName : LPCSTR optional
Fiddle::TYPE_VOIDP, # lpVolumeName : LPCSTR optional
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetVolumeLabelA(
lpRootPathName: *const u8, // LPCSTR optional
lpVolumeName: *const u8 // LPCSTR optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetVolumeLabelA([MarshalAs(UnmanagedType.LPStr)] string lpRootPathName, [MarshalAs(UnmanagedType.LPStr)] string lpVolumeName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetVolumeLabelA' -Namespace Win32 -PassThru
# $api::SetVolumeLabelA(lpRootPathName, lpVolumeName)#uselib "KERNEL32.dll"
#func global SetVolumeLabelA "SetVolumeLabelA" sptr, sptr
; SetVolumeLabelA lpRootPathName, lpVolumeName ; 戻り値は stat
; lpRootPathName : LPCSTR optional -> "sptr"
; lpVolumeName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetVolumeLabelA "SetVolumeLabelA" str, str
; res = SetVolumeLabelA(lpRootPathName, lpVolumeName)
; lpRootPathName : LPCSTR optional -> "str"
; lpVolumeName : LPCSTR optional -> "str"; BOOL SetVolumeLabelA(LPCSTR lpRootPathName, LPCSTR lpVolumeName)
#uselib "KERNEL32.dll"
#cfunc global SetVolumeLabelA "SetVolumeLabelA" str, str
; res = SetVolumeLabelA(lpRootPathName, lpVolumeName)
; lpRootPathName : LPCSTR optional -> "str"
; lpVolumeName : LPCSTR optional -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetVolumeLabelA = kernel32.NewProc("SetVolumeLabelA")
)
// lpRootPathName (LPCSTR optional), lpVolumeName (LPCSTR optional)
r1, _, err := procSetVolumeLabelA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpRootPathName))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpVolumeName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetVolumeLabelA(
lpRootPathName: PAnsiChar; // LPCSTR optional
lpVolumeName: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetVolumeLabelA';result := DllCall("KERNEL32\SetVolumeLabelA"
, "AStr", lpRootPathName ; LPCSTR optional
, "AStr", lpVolumeName ; LPCSTR optional
, "Int") ; return: BOOL●SetVolumeLabelA(lpRootPathName, lpVolumeName) = DLL("KERNEL32.dll", "bool SetVolumeLabelA(char*, char*)")
# 呼び出し: SetVolumeLabelA(lpRootPathName, lpVolumeName)
# lpRootPathName : LPCSTR optional -> "char*"
# lpVolumeName : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetVolumeLabelA(
lpRootPathName: [*c]const u8, // LPCSTR optional
lpVolumeName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;proc SetVolumeLabelA(
lpRootPathName: cstring, # LPCSTR optional
lpVolumeName: cstring # LPCSTR optional
): int32 {.importc: "SetVolumeLabelA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetVolumeLabelA(
const(char)* lpRootPathName, // LPCSTR optional
const(char)* lpVolumeName // LPCSTR optional
);ccall((:SetVolumeLabelA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, Cstring),
lpRootPathName, lpVolumeName)
# lpRootPathName : LPCSTR optional -> Cstring
# lpVolumeName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetVolumeLabelA(
const char* lpRootPathName,
const char* lpVolumeName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetVolumeLabelA(lpRootPathName, lpVolumeName)
-- lpRootPathName : LPCSTR optional
-- lpVolumeName : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetVolumeLabelA = lib.func('__stdcall', 'SetVolumeLabelA', 'int32_t', ['str', 'str']);
// SetVolumeLabelA(lpRootPathName, lpVolumeName)
// lpRootPathName : LPCSTR optional -> 'str'
// lpVolumeName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetVolumeLabelA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.SetVolumeLabelA(lpRootPathName, lpVolumeName)
// lpRootPathName : LPCSTR optional -> "buffer"
// lpVolumeName : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetVolumeLabelA(
const char* lpRootPathName,
const char* lpVolumeName);
C, "KERNEL32.dll");
// $ffi->SetVolumeLabelA(lpRootPathName, lpVolumeName);
// lpRootPathName : LPCSTR optional
// lpVolumeName : LPCSTR 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.ASCII_OPTIONS);
boolean SetVolumeLabelA(
String lpRootPathName, // LPCSTR optional
String lpVolumeName // LPCSTR optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetVolumeLabelA = SetVolumeLabelA(
lpRootPathName : UInt8*, # LPCSTR optional
lpVolumeName : UInt8* # LPCSTR optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetVolumeLabelANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef SetVolumeLabelADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final SetVolumeLabelA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetVolumeLabelANative, SetVolumeLabelADart>('SetVolumeLabelA');
// lpRootPathName : LPCSTR optional -> Pointer<Utf8>
// lpVolumeName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetVolumeLabelA(
lpRootPathName: PAnsiChar; // LPCSTR optional
lpVolumeName: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetVolumeLabelA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetVolumeLabelA"
c_SetVolumeLabelA :: CString -> CString -> IO CInt
-- lpRootPathName : LPCSTR optional -> CString
-- lpVolumeName : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setvolumelabela =
foreign "SetVolumeLabelA"
(string @-> string @-> returning int32_t)
(* lpRootPathName : LPCSTR optional -> string *)
(* lpVolumeName : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetVolumeLabelA" set-volume-label-a :convention :stdcall) :int32
(lp-root-path-name :string) ; LPCSTR optional
(lp-volume-name :string)) ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetVolumeLabelA = Win32::API::More->new('KERNEL32',
'BOOL SetVolumeLabelA(LPCSTR lpRootPathName, LPCSTR lpVolumeName)');
# my $ret = $SetVolumeLabelA->Call($lpRootPathName, $lpVolumeName);
# lpRootPathName : LPCSTR optional -> LPCSTR
# lpVolumeName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SetVolumeLabelW (Unicode版) — ボリュームのラベル名を設定する(Unicode版)。
公式の関連項目
- f GetVolumeInformationA — ルートパスからボリュームの名前やファイルシステム情報を取得する(ANSI版)。