ホーム › Storage.FileSystem › GetVolumeInformationByHandleW

GetVolumeInformationByHandleW

関数

ハンドルからボリュームの名前やファイルシステム情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetVolumeInformationByHandleW(
    HANDLE hFile,
    LPWSTR lpVolumeNameBuffer,   // optional
    DWORD nVolumeNameSize,
    DWORD* lpVolumeSerialNumber,   // optional
    DWORD* lpMaximumComponentLength,   // optional
    DWORD* lpFileSystemFlags,   // optional
    LPWSTR lpFileSystemNameBuffer,   // optional
    DWORD nFileSystemNameSize
);

パラメーター

名前	型	方向
hFile	HANDLE	in
lpVolumeNameBuffer	LPWSTR	outoptional
nVolumeNameSize	DWORD	in
lpVolumeSerialNumber	DWORD*	outoptional
lpMaximumComponentLength	DWORD*	outoptional
lpFileSystemFlags	DWORD*	outoptional
lpFileSystemNameBuffer	LPWSTR	outoptional
nFileSystemNameSize	DWORD	in

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetVolumeInformationByHandleW(
    HANDLE hFile,
    LPWSTR lpVolumeNameBuffer,   // optional
    DWORD nVolumeNameSize,
    DWORD* lpVolumeSerialNumber,   // optional
    DWORD* lpMaximumComponentLength,   // optional
    DWORD* lpFileSystemFlags,   // optional
    LPWSTR lpFileSystemNameBuffer,   // optional
    DWORD nFileSystemNameSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetVolumeInformationByHandleW(
    IntPtr hFile,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpVolumeNameBuffer,   // LPWSTR optional, out
    uint nVolumeNameSize,   // DWORD
    IntPtr lpVolumeSerialNumber,   // DWORD* optional, out
    IntPtr lpMaximumComponentLength,   // DWORD* optional, out
    IntPtr lpFileSystemFlags,   // DWORD* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFileSystemNameBuffer,   // LPWSTR optional, out
    uint nFileSystemNameSize   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetVolumeInformationByHandleW(
    hFile As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpVolumeNameBuffer As System.Text.StringBuilder,   ' LPWSTR 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.LPWStr)> lpFileSystemNameBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    nFileSystemNameSize As UInteger   ' DWORD
) As Boolean
End Function

' hFile : HANDLE
' lpVolumeNameBuffer : LPWSTR optional, out
' nVolumeNameSize : DWORD
' lpVolumeSerialNumber : DWORD* optional, out
' lpMaximumComponentLength : DWORD* optional, out
' lpFileSystemFlags : DWORD* optional, out
' lpFileSystemNameBuffer : LPWSTR optional, out
' nFileSystemNameSize : DWORD
Declare PtrSafe Function GetVolumeInformationByHandleW Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpVolumeNameBuffer As LongPtr, _
    ByVal nVolumeNameSize As Long, _
    ByVal lpVolumeSerialNumber As LongPtr, _
    ByVal lpMaximumComponentLength As LongPtr, _
    ByVal lpFileSystemFlags As LongPtr, _
    ByVal lpFileSystemNameBuffer As LongPtr, _
    ByVal nFileSystemNameSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetVolumeInformationByHandleW = ctypes.windll.kernel32.GetVolumeInformationByHandleW
GetVolumeInformationByHandleW.restype = wintypes.BOOL
GetVolumeInformationByHandleW.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.LPWSTR,  # lpVolumeNameBuffer : LPWSTR 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.LPWSTR,  # lpFileSystemNameBuffer : LPWSTR 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')
GetVolumeInformationByHandleW = Fiddle::Function.new(
  lib['GetVolumeInformationByHandleW'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpVolumeNameBuffer : LPWSTR 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 : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # nFileSystemNameSize : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetVolumeInformationByHandleW(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpVolumeNameBuffer: *mut u16,  // LPWSTR 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 u16,  // LPWSTR optional, out
        nFileSystemNameSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetVolumeInformationByHandleW(IntPtr hFile, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpVolumeNameBuffer, uint nVolumeNameSize, IntPtr lpVolumeSerialNumber, IntPtr lpMaximumComponentLength, IntPtr lpFileSystemFlags, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFileSystemNameBuffer, uint nFileSystemNameSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetVolumeInformationByHandleW' -Namespace Win32 -PassThru
# $api::GetVolumeInformationByHandleW(hFile, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)

#uselib "KERNEL32.dll"
#func global GetVolumeInformationByHandleW "GetVolumeInformationByHandleW" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetVolumeInformationByHandleW hFile, varptr(lpVolumeNameBuffer), nVolumeNameSize, varptr(lpVolumeSerialNumber), varptr(lpMaximumComponentLength), varptr(lpFileSystemFlags), varptr(lpFileSystemNameBuffer), nFileSystemNameSize   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; lpVolumeNameBuffer : LPWSTR optional, out -> "sptr"
; nVolumeNameSize : DWORD -> "sptr"
; lpVolumeSerialNumber : DWORD* optional, out -> "sptr"
; lpMaximumComponentLength : DWORD* optional, out -> "sptr"
; lpFileSystemFlags : DWORD* optional, out -> "sptr"
; lpFileSystemNameBuffer : LPWSTR optional, out -> "sptr"
; nFileSystemNameSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationByHandleW "GetVolumeInformationByHandleW" sptr, var, int, var, var, var, var, int
; res = GetVolumeInformationByHandleW(hFile, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
; hFile : HANDLE -> "sptr"
; lpVolumeNameBuffer : LPWSTR optional, out -> "var"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "var"
; lpMaximumComponentLength : DWORD* optional, out -> "var"
; lpFileSystemFlags : DWORD* optional, out -> "var"
; lpFileSystemNameBuffer : LPWSTR optional, out -> "var"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationByHandleW "GetVolumeInformationByHandleW" sptr, sptr, int, sptr, sptr, sptr, sptr, int
; res = GetVolumeInformationByHandleW(hFile, varptr(lpVolumeNameBuffer), nVolumeNameSize, varptr(lpVolumeSerialNumber), varptr(lpMaximumComponentLength), varptr(lpFileSystemFlags), varptr(lpFileSystemNameBuffer), nFileSystemNameSize)
; hFile : HANDLE -> "sptr"
; lpVolumeNameBuffer : LPWSTR optional, out -> "sptr"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "sptr"
; lpMaximumComponentLength : DWORD* optional, out -> "sptr"
; lpFileSystemFlags : DWORD* optional, out -> "sptr"
; lpFileSystemNameBuffer : LPWSTR optional, out -> "sptr"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetVolumeInformationByHandleW(HANDLE hFile, LPWSTR lpVolumeNameBuffer, DWORD nVolumeNameSize, DWORD* lpVolumeSerialNumber, DWORD* lpMaximumComponentLength, DWORD* lpFileSystemFlags, LPWSTR lpFileSystemNameBuffer, DWORD nFileSystemNameSize)
#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationByHandleW "GetVolumeInformationByHandleW" intptr, var, int, var, var, var, var, int
; res = GetVolumeInformationByHandleW(hFile, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
; hFile : HANDLE -> "intptr"
; lpVolumeNameBuffer : LPWSTR optional, out -> "var"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "var"
; lpMaximumComponentLength : DWORD* optional, out -> "var"
; lpFileSystemFlags : DWORD* optional, out -> "var"
; lpFileSystemNameBuffer : LPWSTR optional, out -> "var"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetVolumeInformationByHandleW(HANDLE hFile, LPWSTR lpVolumeNameBuffer, DWORD nVolumeNameSize, DWORD* lpVolumeSerialNumber, DWORD* lpMaximumComponentLength, DWORD* lpFileSystemFlags, LPWSTR lpFileSystemNameBuffer, DWORD nFileSystemNameSize)
#uselib "KERNEL32.dll"
#cfunc global GetVolumeInformationByHandleW "GetVolumeInformationByHandleW" intptr, intptr, int, intptr, intptr, intptr, intptr, int
; res = GetVolumeInformationByHandleW(hFile, varptr(lpVolumeNameBuffer), nVolumeNameSize, varptr(lpVolumeSerialNumber), varptr(lpMaximumComponentLength), varptr(lpFileSystemFlags), varptr(lpFileSystemNameBuffer), nFileSystemNameSize)
; hFile : HANDLE -> "intptr"
; lpVolumeNameBuffer : LPWSTR optional, out -> "intptr"
; nVolumeNameSize : DWORD -> "int"
; lpVolumeSerialNumber : DWORD* optional, out -> "intptr"
; lpMaximumComponentLength : DWORD* optional, out -> "intptr"
; lpFileSystemFlags : DWORD* optional, out -> "intptr"
; lpFileSystemNameBuffer : LPWSTR optional, out -> "intptr"
; nFileSystemNameSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetVolumeInformationByHandleW = kernel32.NewProc("GetVolumeInformationByHandleW")
)

// hFile (HANDLE), lpVolumeNameBuffer (LPWSTR optional, out), nVolumeNameSize (DWORD), lpVolumeSerialNumber (DWORD* optional, out), lpMaximumComponentLength (DWORD* optional, out), lpFileSystemFlags (DWORD* optional, out), lpFileSystemNameBuffer (LPWSTR optional, out), nFileSystemNameSize (DWORD)
r1, _, err := procGetVolumeInformationByHandleW.Call(
	uintptr(hFile),
	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 GetVolumeInformationByHandleW(
  hFile: THandle;   // HANDLE
  lpVolumeNameBuffer: PWideChar;   // LPWSTR optional, out
  nVolumeNameSize: DWORD;   // DWORD
  lpVolumeSerialNumber: Pointer;   // DWORD* optional, out
  lpMaximumComponentLength: Pointer;   // DWORD* optional, out
  lpFileSystemFlags: Pointer;   // DWORD* optional, out
  lpFileSystemNameBuffer: PWideChar;   // LPWSTR optional, out
  nFileSystemNameSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetVolumeInformationByHandleW';

result := DllCall("KERNEL32\GetVolumeInformationByHandleW"
    , "Ptr", hFile   ; HANDLE
    , "Ptr", lpVolumeNameBuffer   ; LPWSTR optional, out
    , "UInt", nVolumeNameSize   ; DWORD
    , "Ptr", lpVolumeSerialNumber   ; DWORD* optional, out
    , "Ptr", lpMaximumComponentLength   ; DWORD* optional, out
    , "Ptr", lpFileSystemFlags   ; DWORD* optional, out
    , "Ptr", lpFileSystemNameBuffer   ; LPWSTR optional, out
    , "UInt", nFileSystemNameSize   ; DWORD
    , "Int")   ; return: BOOL

●GetVolumeInformationByHandleW(hFile, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize) = DLL("KERNEL32.dll", "bool GetVolumeInformationByHandleW(void*, char*, dword, void*, void*, void*, char*, dword)")
# 呼び出し: GetVolumeInformationByHandleW(hFile, lpVolumeNameBuffer, nVolumeNameSize, lpVolumeSerialNumber, lpMaximumComponentLength, lpFileSystemFlags, lpFileSystemNameBuffer, nFileSystemNameSize)
# hFile : HANDLE -> "void*"
# lpVolumeNameBuffer : LPWSTR optional, out -> "char*"
# nVolumeNameSize : DWORD -> "dword"
# lpVolumeSerialNumber : DWORD* optional, out -> "void*"
# lpMaximumComponentLength : DWORD* optional, out -> "void*"
# lpFileSystemFlags : DWORD* optional, out -> "void*"
# lpFileSystemNameBuffer : LPWSTR optional, out -> "char*"
# nFileSystemNameSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。