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

CompactVirtualDisk

関数
可変サイズ仮想ディスクの未使用領域を圧縮し縮小する。
DLLVirtDisk.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR CompactVirtualDisk(
    HANDLE VirtualDiskHandle,
    COMPACT_VIRTUAL_DISK_FLAG Flags,
    COMPACT_VIRTUAL_DISK_PARAMETERS* Parameters,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前型方向説明
VirtualDiskHandleHANDLEin圧縮(コンパクト)する対象の仮想ディスクのハンドル。動的VHD/VHDXの未使用領域を回収する。
FlagsCOMPACT_VIRTUAL_DISK_FLAGin圧縮動作を制御するCOMPACT_VIRTUAL_DISK_FLAGのビットフラグ。通常はNONEを指定する。
ParametersCOMPACT_VIRTUAL_DISK_PARAMETERS*inoptional圧縮パラメータを格納したCOMPACT_VIRTUAL_DISK_PARAMETERS構造体へのポインタ。Versionを設定する。
OverlappedOVERLAPPED*inoptional非同期実行用のOVERLAPPED構造体へのポインタ。同期実行する場合はNULL可。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR CompactVirtualDisk(
    HANDLE VirtualDiskHandle,
    COMPACT_VIRTUAL_DISK_FLAG Flags,
    COMPACT_VIRTUAL_DISK_PARAMETERS* Parameters,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("VirtDisk.dll", ExactSpelling = true)]
static extern uint CompactVirtualDisk(
    IntPtr VirtualDiskHandle,   // HANDLE
    int Flags,   // COMPACT_VIRTUAL_DISK_FLAG
    IntPtr Parameters,   // COMPACT_VIRTUAL_DISK_PARAMETERS* optional
    IntPtr Overlapped   // OVERLAPPED* optional
);
<DllImport("VirtDisk.dll", ExactSpelling:=True)>
Public Shared Function CompactVirtualDisk(
    VirtualDiskHandle As IntPtr,   ' HANDLE
    Flags As Integer,   ' COMPACT_VIRTUAL_DISK_FLAG
    Parameters As IntPtr,   ' COMPACT_VIRTUAL_DISK_PARAMETERS* optional
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As UInteger
End Function
' VirtualDiskHandle : HANDLE
' Flags : COMPACT_VIRTUAL_DISK_FLAG
' Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function CompactVirtualDisk Lib "virtdisk" ( _
    ByVal VirtualDiskHandle As LongPtr, _
    ByVal Flags As Long, _
    ByVal Parameters As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CompactVirtualDisk = ctypes.windll.virtdisk.CompactVirtualDisk
CompactVirtualDisk.restype = wintypes.DWORD
CompactVirtualDisk.argtypes = [
    wintypes.HANDLE,  # VirtualDiskHandle : HANDLE
    ctypes.c_int,  # Flags : COMPACT_VIRTUAL_DISK_FLAG
    ctypes.c_void_p,  # Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	virtdisk = windows.NewLazySystemDLL("VirtDisk.dll")
	procCompactVirtualDisk = virtdisk.NewProc("CompactVirtualDisk")
)

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

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

typedef CompactVirtualDiskNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Void>, Pointer<Void>);
typedef CompactVirtualDiskDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final CompactVirtualDisk = DynamicLibrary.open('VirtDisk.dll')
    .lookupFunction<CompactVirtualDiskNative, CompactVirtualDiskDart>('CompactVirtualDisk');
// VirtualDiskHandle : HANDLE -> Pointer<Void>
// Flags : COMPACT_VIRTUAL_DISK_FLAG -> Int32
// Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional -> Pointer<Void>
// Overlapped : OVERLAPPED* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CompactVirtualDisk(
  VirtualDiskHandle: THandle;   // HANDLE
  Flags: Integer;   // COMPACT_VIRTUAL_DISK_FLAG
  Parameters: Pointer;   // COMPACT_VIRTUAL_DISK_PARAMETERS* optional
  Overlapped: Pointer   // OVERLAPPED* optional
): DWORD; stdcall;
  external 'VirtDisk.dll' name 'CompactVirtualDisk';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CompactVirtualDisk"
  c_CompactVirtualDisk :: Ptr () -> Int32 -> Ptr () -> Ptr () -> IO Word32
-- VirtualDiskHandle : HANDLE -> Ptr ()
-- Flags : COMPACT_VIRTUAL_DISK_FLAG -> Int32
-- Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional -> Ptr ()
-- Overlapped : OVERLAPPED* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let compactvirtualdisk =
  foreign "CompactVirtualDisk"
    ((ptr void) @-> int32_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* VirtualDiskHandle : HANDLE -> (ptr void) *)
(* Flags : COMPACT_VIRTUAL_DISK_FLAG -> int32_t *)
(* Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional -> (ptr void) *)
(* Overlapped : OVERLAPPED* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library virtdisk (t "VirtDisk.dll"))
(cffi:use-foreign-library virtdisk)

(cffi:defcfun ("CompactVirtualDisk" compact-virtual-disk :convention :stdcall) :uint32
  (virtual-disk-handle :pointer)   ; HANDLE
  (flags :int32)   ; COMPACT_VIRTUAL_DISK_FLAG
  (parameters :pointer)   ; COMPACT_VIRTUAL_DISK_PARAMETERS* optional
  (overlapped :pointer))   ; OVERLAPPED* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CompactVirtualDisk = Win32::API::More->new('VirtDisk',
    'DWORD CompactVirtualDisk(HANDLE VirtualDiskHandle, int Flags, LPVOID Parameters, LPVOID Overlapped)');
# my $ret = $CompactVirtualDisk->Call($VirtualDiskHandle, $Flags, $Parameters, $Overlapped);
# VirtualDiskHandle : HANDLE -> HANDLE
# Flags : COMPACT_VIRTUAL_DISK_FLAG -> int
# Parameters : COMPACT_VIRTUAL_DISK_PARAMETERS* optional -> LPVOID
# Overlapped : OVERLAPPED* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型