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

GetVolumeInformationA

関数
ルートパスからボリュームの名前やファイルシステム情報を取得する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetVolumeInformationA(
    LPCSTR lpRootPathName,   // optional
    LPSTR lpVolumeNameBuffer,   // optional
    DWORD nVolumeNameSize,
    DWORD* lpVolumeSerialNumber,   // optional
    DWORD* lpMaximumComponentLength,   // optional
    DWORD* lpFileSystemFlags,   // optional
    LPSTR lpFileSystemNameBuffer,   // optional
    DWORD nFileSystemNameSize
);

パラメーター

名前方向
lpRootPathNameLPCSTRinoptional
lpVolumeNameBufferLPSTRoutoptional
nVolumeNameSizeDWORDin
lpVolumeSerialNumberDWORD*outoptional
lpMaximumComponentLengthDWORD*outoptional
lpFileSystemFlagsDWORD*outoptional
lpFileSystemNameBufferLPSTRoutoptional
nFileSystemNameSizeDWORDin

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetVolumeInformationA(
    LPCSTR lpRootPathName,   // optional
    LPSTR lpVolumeNameBuffer,   // optional
    DWORD nVolumeNameSize,
    DWORD* lpVolumeSerialNumber,   // optional
    DWORD* lpMaximumComponentLength,   // optional
    DWORD* lpFileSystemFlags,   // optional
    LPSTR lpFileSystemNameBuffer,   // optional
    DWORD nFileSystemNameSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetVolumeInformationA(
    [MarshalAs(UnmanagedType.LPStr)] string lpRootPathName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpVolumeNameBuffer,   // LPSTR optional, out
    uint nVolumeNameSize,   // DWORD
    IntPtr lpVolumeSerialNumber,   // DWORD* optional, out
    IntPtr lpMaximumComponentLength,   // DWORD* optional, out
    IntPtr lpFileSystemFlags,   // DWORD* optional, out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFileSystemNameBuffer,   // LPSTR optional, out
    uint nFileSystemNameSize   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetVolumeInformationA(
    <MarshalAs(UnmanagedType.LPStr)> lpRootPathName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpVolumeNameBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    nVolumeNameSize As UInteger,   ' DWORD
    lpVolumeSerialNumber As IntPtr,   ' DWORD* optional, out
    lpMaximumComponentLength As IntPtr,   ' DWORD* optional, out
    lpFileSystemFlags As IntPtr,   ' DWORD* optional, out
    <MarshalAs(UnmanagedType.LPStr)> lpFileSystemNameBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    nFileSystemNameSize As UInteger   ' DWORD
) As Boolean
End Function
' lpRootPathName : LPCSTR optional
' lpVolumeNameBuffer : LPSTR optional, out
' nVolumeNameSize : DWORD
' lpVolumeSerialNumber : DWORD* optional, out
' lpMaximumComponentLength : DWORD* optional, out
' lpFileSystemFlags : DWORD* optional, out
' lpFileSystemNameBuffer : LPSTR optional, out
' nFileSystemNameSize : DWORD
Declare PtrSafe Function GetVolumeInformationA Lib "kernel32" ( _
    ByVal lpRootPathName As String, _
    ByVal lpVolumeNameBuffer As String, _
    ByVal nVolumeNameSize As Long, _
    ByVal lpVolumeSerialNumber As LongPtr, _
    ByVal lpMaximumComponentLength As LongPtr, _
    ByVal lpFileSystemFlags As LongPtr, _
    ByVal lpFileSystemNameBuffer As String, _
    ByVal nFileSystemNameSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetVolumeInformationA = ctypes.windll.kernel32.GetVolumeInformationA
GetVolumeInformationA.restype = wintypes.BOOL
GetVolumeInformationA.argtypes = [
    wintypes.LPCSTR,  # lpRootPathName : LPCSTR optional
    wintypes.LPSTR,  # lpVolumeNameBuffer : LPSTR optional, out
    wintypes.DWORD,  # nVolumeNameSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpVolumeSerialNumber : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpMaximumComponentLength : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpFileSystemFlags : DWORD* optional, out
    wintypes.LPSTR,  # lpFileSystemNameBuffer : LPSTR optional, out
    wintypes.DWORD,  # nFileSystemNameSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetVolumeInformationA = Fiddle::Function.new(
  lib['GetVolumeInformationA'],
  [
    Fiddle::TYPE_VOIDP,  # lpRootPathName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpVolumeNameBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nVolumeNameSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpVolumeSerialNumber : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpMaximumComponentLength : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpFileSystemFlags : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpFileSystemNameBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nFileSystemNameSize : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetVolumeInformationA(
        lpRootPathName: *const u8,  // LPCSTR optional
        lpVolumeNameBuffer: *mut u8,  // LPSTR optional, out
        nVolumeNameSize: u32,  // DWORD
        lpVolumeSerialNumber: *mut u32,  // DWORD* optional, out
        lpMaximumComponentLength: *mut u32,  // DWORD* optional, out
        lpFileSystemFlags: *mut u32,  // DWORD* optional, out
        lpFileSystemNameBuffer: *mut u8,  // LPSTR optional, out
        nFileSystemNameSize: u32  // DWORD
    ) -> 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 GetVolumeInformationA([MarshalAs(UnmanagedType.LPStr)] string lpRootPathName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpVolumeNameBuffer, uint nVolumeNameSize, IntPtr lpVolumeSerialNumber, IntPtr lpMaximumComponentLength, IntPtr lpFileSystemFlags, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFileSystemNameBuffer, uint nFileSystemNameSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetVolumeInformationA' -Namespace Win32 -PassThru
# $api::GetVolumeInformationA(lpRootPathName, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
#uselib "KERNEL32.dll"
#func global GetVolumeInformationA "GetVolumeInformationA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetVolumeInformationA lpRootPathName, varptr(lpVolumeNameBuffer), nVolumeNameSize, varptr(lpVolumeSerialNumber), varptr(lpMaximumComponentLength), varptr(lpFileSystemFlags), varptr(lpFileSystemNameBuffer), nFileSystemNameSize   ; 戻り値は stat
; lpRootPathName : LPCSTR optional -> "sptr"
; lpVolumeNameBuffer : LPSTR optional, out -> "sptr"
; nVolumeNameSize : DWORD -> "sptr"
; lpVolumeSerialNumber : DWORD* optional, out -> "sptr"
; lpMaximumComponentLength : DWORD* optional, out -> "sptr"
; lpFileSystemFlags : DWORD* optional, out -> "sptr"
; lpFileSystemNameBuffer : LPSTR optional, out -> "sptr"
; nFileSystemNameSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationA "GetVolumeInformationA" str, var, int, var, var, var, var, int
; res = GetVolumeInformationA(lpRootPathName, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
; lpRootPathName : LPCSTR optional -> "str"
; lpVolumeNameBuffer : LPSTR optional, out -> "var"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "var"
; lpMaximumComponentLength : DWORD* optional, out -> "var"
; lpFileSystemFlags : DWORD* optional, out -> "var"
; lpFileSystemNameBuffer : LPSTR optional, out -> "var"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetVolumeInformationA(LPCSTR lpRootPathName, LPSTR lpVolumeNameBuffer, DWORD nVolumeNameSize, DWORD* lpVolumeSerialNumber, DWORD* lpMaximumComponentLength, DWORD* lpFileSystemFlags, LPSTR lpFileSystemNameBuffer, DWORD nFileSystemNameSize)
#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationA "GetVolumeInformationA" str, var, int, var, var, var, var, int
; res = GetVolumeInformationA(lpRootPathName, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
; lpRootPathName : LPCSTR optional -> "str"
; lpVolumeNameBuffer : LPSTR optional, out -> "var"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "var"
; lpMaximumComponentLength : DWORD* optional, out -> "var"
; lpFileSystemFlags : DWORD* optional, out -> "var"
; lpFileSystemNameBuffer : LPSTR optional, out -> "var"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetVolumeInformationA = kernel32.NewProc("GetVolumeInformationA")
)

// lpRootPathName (LPCSTR optional), lpVolumeNameBuffer (LPSTR optional, out), nVolumeNameSize (DWORD), lpVolumeSerialNumber (DWORD* optional, out), lpMaximumComponentLength (DWORD* optional, out), lpFileSystemFlags (DWORD* optional, out), lpFileSystemNameBuffer (LPSTR optional, out), nFileSystemNameSize (DWORD)
r1, _, err := procGetVolumeInformationA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpRootPathName))),
	uintptr(lpVolumeNameBuffer),
	uintptr(nVolumeNameSize),
	uintptr(lpVolumeSerialNumber),
	uintptr(lpMaximumComponentLength),
	uintptr(lpFileSystemFlags),
	uintptr(lpFileSystemNameBuffer),
	uintptr(nFileSystemNameSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetVolumeInformationA(
  lpRootPathName: PAnsiChar;   // LPCSTR optional
  lpVolumeNameBuffer: PAnsiChar;   // LPSTR optional, out
  nVolumeNameSize: DWORD;   // DWORD
  lpVolumeSerialNumber: Pointer;   // DWORD* optional, out
  lpMaximumComponentLength: Pointer;   // DWORD* optional, out
  lpFileSystemFlags: Pointer;   // DWORD* optional, out
  lpFileSystemNameBuffer: PAnsiChar;   // LPSTR optional, out
  nFileSystemNameSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetVolumeInformationA';
result := DllCall("KERNEL32\GetVolumeInformationA"
    , "AStr", lpRootPathName   ; LPCSTR optional
    , "Ptr", lpVolumeNameBuffer   ; LPSTR optional, out
    , "UInt", nVolumeNameSize   ; DWORD
    , "Ptr", lpVolumeSerialNumber   ; DWORD* optional, out
    , "Ptr", lpMaximumComponentLength   ; DWORD* optional, out
    , "Ptr", lpFileSystemFlags   ; DWORD* optional, out
    , "Ptr", lpFileSystemNameBuffer   ; LPSTR optional, out
    , "UInt", nFileSystemNameSize   ; DWORD
    , "Int")   ; return: BOOL
●GetVolumeInformationA(lpRootPathName, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize) = DLL("KERNEL32.dll", "bool GetVolumeInformationA(char*, char*, dword, void*, void*, void*, char*, dword)")
# 呼び出し: GetVolumeInformationA(lpRootPathName, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
# lpRootPathName : LPCSTR optional -> "char*"
# lpVolumeNameBuffer : LPSTR optional, out -> "char*"
# nVolumeNameSize : DWORD -> "dword"
# lpVolumeSerialNumber : DWORD* optional, out -> "void*"
# lpMaximumComponentLength : DWORD* optional, out -> "void*"
# lpFileSystemFlags : DWORD* optional, out -> "void*"
# lpFileSystemNameBuffer : LPSTR optional, out -> "char*"
# nFileSystemNameSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。