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

GetVirtualDiskInformation

関数
仮想ディスクの各種属性情報を取得する。
DLLVirtDisk.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetVirtualDiskInformation(
    HANDLE VirtualDiskHandle,
    DWORD* VirtualDiskInfoSize,
    GET_VIRTUAL_DISK_INFO* VirtualDiskInfo,
    DWORD* SizeUsed   // optional
);

パラメーター

名前型方向説明
VirtualDiskHandleHANDLEin情報を取得する仮想ディスクのハンドル。OpenVirtualDiskで取得したものを渡す。
VirtualDiskInfoSizeDWORD*inoutVirtualDiskInfoバッファのサイズを入出力するDWORDポインタ。不足時は必要サイズが返る。
VirtualDiskInfoGET_VIRTUAL_DISK_INFO*inout取得した情報を受け取るGET_VIRTUAL_DISK_INFO構造体へのポインタ。先頭のVersionで取得項目を指定する。
SizeUsedDWORD*outoptional実際に書き込まれたバイト数を返すDWORDポインタ。NULL可。バッファ消費量の確認に用いる。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR GetVirtualDiskInformation(
    HANDLE VirtualDiskHandle,
    DWORD* VirtualDiskInfoSize,
    GET_VIRTUAL_DISK_INFO* VirtualDiskInfo,
    DWORD* SizeUsed   // optional
);
[DllImport("VirtDisk.dll", ExactSpelling = true)]
static extern uint GetVirtualDiskInformation(
    IntPtr VirtualDiskHandle,   // HANDLE
    ref uint VirtualDiskInfoSize,   // DWORD* in/out
    IntPtr VirtualDiskInfo,   // GET_VIRTUAL_DISK_INFO* in/out
    IntPtr SizeUsed   // DWORD* optional, out
);
<DllImport("VirtDisk.dll", ExactSpelling:=True)>
Public Shared Function GetVirtualDiskInformation(
    VirtualDiskHandle As IntPtr,   ' HANDLE
    ByRef VirtualDiskInfoSize As UInteger,   ' DWORD* in/out
    VirtualDiskInfo As IntPtr,   ' GET_VIRTUAL_DISK_INFO* in/out
    SizeUsed As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' VirtualDiskHandle : HANDLE
' VirtualDiskInfoSize : DWORD* in/out
' VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out
' SizeUsed : DWORD* optional, out
Declare PtrSafe Function GetVirtualDiskInformation Lib "virtdisk" ( _
    ByVal VirtualDiskHandle As LongPtr, _
    ByRef VirtualDiskInfoSize As Long, _
    ByVal VirtualDiskInfo As LongPtr, _
    ByVal SizeUsed As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetVirtualDiskInformation = ctypes.windll.virtdisk.GetVirtualDiskInformation
GetVirtualDiskInformation.restype = wintypes.DWORD
GetVirtualDiskInformation.argtypes = [
    wintypes.HANDLE,  # VirtualDiskHandle : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # VirtualDiskInfoSize : DWORD* in/out
    ctypes.c_void_p,  # VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out
    ctypes.POINTER(wintypes.DWORD),  # SizeUsed : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VirtDisk.dll')
GetVirtualDiskInformation = Fiddle::Function.new(
  lib['GetVirtualDiskInformation'],
  [
    Fiddle::TYPE_VOIDP,  # VirtualDiskHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # VirtualDiskInfoSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out
    Fiddle::TYPE_VOIDP,  # SizeUsed : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "virtdisk")]
extern "system" {
    fn GetVirtualDiskInformation(
        VirtualDiskHandle: *mut core::ffi::c_void,  // HANDLE
        VirtualDiskInfoSize: *mut u32,  // DWORD* in/out
        VirtualDiskInfo: *mut GET_VIRTUAL_DISK_INFO,  // GET_VIRTUAL_DISK_INFO* in/out
        SizeUsed: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("VirtDisk.dll")]
public static extern uint GetVirtualDiskInformation(IntPtr VirtualDiskHandle, ref uint VirtualDiskInfoSize, IntPtr VirtualDiskInfo, IntPtr SizeUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VirtDisk_GetVirtualDiskInformation' -Namespace Win32 -PassThru
# $api::GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
#uselib "VirtDisk.dll"
#func global GetVirtualDiskInformation "GetVirtualDiskInformation" sptr, sptr, sptr, sptr
; GetVirtualDiskInformation VirtualDiskHandle, varptr(VirtualDiskInfoSize), varptr(VirtualDiskInfo), varptr(SizeUsed)   ; 戻り値は stat
; VirtualDiskHandle : HANDLE -> "sptr"
; VirtualDiskInfoSize : DWORD* in/out -> "sptr"
; VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> "sptr"
; SizeUsed : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "VirtDisk.dll"
#cfunc global GetVirtualDiskInformation "GetVirtualDiskInformation" sptr, var, var, var
; res = GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
; VirtualDiskHandle : HANDLE -> "sptr"
; VirtualDiskInfoSize : DWORD* in/out -> "var"
; VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> "var"
; SizeUsed : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; WIN32_ERROR GetVirtualDiskInformation(HANDLE VirtualDiskHandle, DWORD* VirtualDiskInfoSize, GET_VIRTUAL_DISK_INFO* VirtualDiskInfo, DWORD* SizeUsed)
#uselib "VirtDisk.dll"
#cfunc global GetVirtualDiskInformation "GetVirtualDiskInformation" intptr, var, var, var
; res = GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
; VirtualDiskHandle : HANDLE -> "intptr"
; VirtualDiskInfoSize : DWORD* in/out -> "var"
; VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> "var"
; SizeUsed : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	virtdisk = windows.NewLazySystemDLL("VirtDisk.dll")
	procGetVirtualDiskInformation = virtdisk.NewProc("GetVirtualDiskInformation")
)

// VirtualDiskHandle (HANDLE), VirtualDiskInfoSize (DWORD* in/out), VirtualDiskInfo (GET_VIRTUAL_DISK_INFO* in/out), SizeUsed (DWORD* optional, out)
r1, _, err := procGetVirtualDiskInformation.Call(
	uintptr(VirtualDiskHandle),
	uintptr(VirtualDiskInfoSize),
	uintptr(VirtualDiskInfo),
	uintptr(SizeUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetVirtualDiskInformation(
  VirtualDiskHandle: THandle;   // HANDLE
  VirtualDiskInfoSize: Pointer;   // DWORD* in/out
  VirtualDiskInfo: Pointer;   // GET_VIRTUAL_DISK_INFO* in/out
  SizeUsed: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'VirtDisk.dll' name 'GetVirtualDiskInformation';
result := DllCall("VirtDisk\GetVirtualDiskInformation"
    , "Ptr", VirtualDiskHandle   ; HANDLE
    , "Ptr", VirtualDiskInfoSize   ; DWORD* in/out
    , "Ptr", VirtualDiskInfo   ; GET_VIRTUAL_DISK_INFO* in/out
    , "Ptr", SizeUsed   ; DWORD* optional, out
    , "UInt")   ; return: WIN32_ERROR
●GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed) = DLL("VirtDisk.dll", "dword GetVirtualDiskInformation(void*, void*, void*, void*)")
# 呼び出し: GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
# VirtualDiskHandle : HANDLE -> "void*"
# VirtualDiskInfoSize : DWORD* in/out -> "void*"
# VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> "void*"
# SizeUsed : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "virtdisk" fn GetVirtualDiskInformation(
    VirtualDiskHandle: ?*anyopaque, // HANDLE
    VirtualDiskInfoSize: [*c]u32, // DWORD* in/out
    VirtualDiskInfo: [*c]GET_VIRTUAL_DISK_INFO, // GET_VIRTUAL_DISK_INFO* in/out
    SizeUsed: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc GetVirtualDiskInformation(
    VirtualDiskHandle: pointer,  # HANDLE
    VirtualDiskInfoSize: ptr uint32,  # DWORD* in/out
    VirtualDiskInfo: ptr GET_VIRTUAL_DISK_INFO,  # GET_VIRTUAL_DISK_INFO* in/out
    SizeUsed: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "GetVirtualDiskInformation", stdcall, dynlib: "VirtDisk.dll".}
pragma(lib, "virtdisk");
extern(Windows)
uint GetVirtualDiskInformation(
    void* VirtualDiskHandle,   // HANDLE
    uint* VirtualDiskInfoSize,   // DWORD* in/out
    GET_VIRTUAL_DISK_INFO* VirtualDiskInfo,   // GET_VIRTUAL_DISK_INFO* in/out
    uint* SizeUsed   // DWORD* optional, out
);
ccall((:GetVirtualDiskInformation, "VirtDisk.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{GET_VIRTUAL_DISK_INFO}, Ptr{UInt32}),
      VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
# VirtualDiskHandle : HANDLE -> Ptr{Cvoid}
# VirtualDiskInfoSize : DWORD* in/out -> Ptr{UInt32}
# VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> Ptr{GET_VIRTUAL_DISK_INFO}
# SizeUsed : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetVirtualDiskInformation(
    void* VirtualDiskHandle,
    uint32_t* VirtualDiskInfoSize,
    void* VirtualDiskInfo,
    uint32_t* SizeUsed);
]]
local virtdisk = ffi.load("virtdisk")
-- virtdisk.GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
-- VirtualDiskHandle : HANDLE
-- VirtualDiskInfoSize : DWORD* in/out
-- VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out
-- SizeUsed : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('VirtDisk.dll');
const GetVirtualDiskInformation = lib.func('__stdcall', 'GetVirtualDiskInformation', 'uint32_t', ['void *', 'uint32_t *', 'void *', 'uint32_t *']);
// GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
// VirtualDiskHandle : HANDLE -> 'void *'
// VirtualDiskInfoSize : DWORD* in/out -> 'uint32_t *'
// VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> 'void *'
// SizeUsed : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("VirtDisk.dll", {
  GetVirtualDiskInformation: { parameters: ["pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed)
// VirtualDiskHandle : HANDLE -> "pointer"
// VirtualDiskInfoSize : DWORD* in/out -> "pointer"
// VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> "pointer"
// SizeUsed : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetVirtualDiskInformation(
    void* VirtualDiskHandle,
    uint32_t* VirtualDiskInfoSize,
    void* VirtualDiskInfo,
    uint32_t* SizeUsed);
C, "VirtDisk.dll");
// $ffi->GetVirtualDiskInformation(VirtualDiskHandle, VirtualDiskInfoSize, VirtualDiskInfo, SizeUsed);
// VirtualDiskHandle : HANDLE
// VirtualDiskInfoSize : DWORD* in/out
// VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out
// SizeUsed : DWORD* optional, out
// 構造体/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 Virtdisk extends StdCallLibrary {
    Virtdisk INSTANCE = Native.load("virtdisk", Virtdisk.class);
    int GetVirtualDiskInformation(
        Pointer VirtualDiskHandle,   // HANDLE
        IntByReference VirtualDiskInfoSize,   // DWORD* in/out
        Pointer VirtualDiskInfo,   // GET_VIRTUAL_DISK_INFO* in/out
        IntByReference SizeUsed   // DWORD* optional, out
    );
}
@[Link("virtdisk")]
lib LibVirtDisk
  fun GetVirtualDiskInformation = GetVirtualDiskInformation(
    VirtualDiskHandle : Void*,   # HANDLE
    VirtualDiskInfoSize : UInt32*,   # DWORD* in/out
    VirtualDiskInfo : GET_VIRTUAL_DISK_INFO*,   # GET_VIRTUAL_DISK_INFO* in/out
    SizeUsed : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetVirtualDiskInformationNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
typedef GetVirtualDiskInformationDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
final GetVirtualDiskInformation = DynamicLibrary.open('VirtDisk.dll')
    .lookupFunction<GetVirtualDiskInformationNative, GetVirtualDiskInformationDart>('GetVirtualDiskInformation');
// VirtualDiskHandle : HANDLE -> Pointer<Void>
// VirtualDiskInfoSize : DWORD* in/out -> Pointer<Uint32>
// VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> Pointer<Void>
// SizeUsed : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetVirtualDiskInformation(
  VirtualDiskHandle: THandle;   // HANDLE
  VirtualDiskInfoSize: Pointer;   // DWORD* in/out
  VirtualDiskInfo: Pointer;   // GET_VIRTUAL_DISK_INFO* in/out
  SizeUsed: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'VirtDisk.dll' name 'GetVirtualDiskInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetVirtualDiskInformation"
  c_GetVirtualDiskInformation :: Ptr () -> Ptr Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- VirtualDiskHandle : HANDLE -> Ptr ()
-- VirtualDiskInfoSize : DWORD* in/out -> Ptr Word32
-- VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> Ptr ()
-- SizeUsed : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getvirtualdiskinformation =
  foreign "GetVirtualDiskInformation"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* VirtualDiskHandle : HANDLE -> (ptr void) *)
(* VirtualDiskInfoSize : DWORD* in/out -> (ptr uint32_t) *)
(* VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> (ptr void) *)
(* SizeUsed : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library virtdisk (t "VirtDisk.dll"))
(cffi:use-foreign-library virtdisk)

(cffi:defcfun ("GetVirtualDiskInformation" get-virtual-disk-information :convention :stdcall) :uint32
  (virtual-disk-handle :pointer)   ; HANDLE
  (virtual-disk-info-size :pointer)   ; DWORD* in/out
  (virtual-disk-info :pointer)   ; GET_VIRTUAL_DISK_INFO* in/out
  (size-used :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetVirtualDiskInformation = Win32::API::More->new('VirtDisk',
    'DWORD GetVirtualDiskInformation(HANDLE VirtualDiskHandle, LPVOID VirtualDiskInfoSize, LPVOID VirtualDiskInfo, LPVOID SizeUsed)');
# my $ret = $GetVirtualDiskInformation->Call($VirtualDiskHandle, $VirtualDiskInfoSize, $VirtualDiskInfo, $SizeUsed);
# VirtualDiskHandle : HANDLE -> HANDLE
# VirtualDiskInfoSize : DWORD* in/out -> LPVOID
# VirtualDiskInfo : GET_VIRTUAL_DISK_INFO* in/out -> LPVOID
# SizeUsed : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型