MergeVirtualDisk

関数

差分仮想ディスクを親ディスクへ統合する。

DLLVirtDisk.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

WIN32_ERROR MergeVirtualDisk(
    HANDLE VirtualDiskHandle,
    MERGE_VIRTUAL_DISK_FLAG Flags,
    MERGE_VIRTUAL_DISK_PARAMETERS* Parameters,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
VirtualDiskHandle	HANDLE	in	開かれている仮想ディスクへのハンドル。VIRTUAL_DISK_ACCESS_METAOPS フラグを使用して開かれている必要があります。仮想ディスクを開く方法については、OpenVirtualDisk 関数を参照してください。
Flags	MERGE_VIRTUAL_DISK_FLAG	in	MERGE_VIRTUAL_DISK_FLAG 列挙型の MERGE_VIRTUAL_DISK_FLAG_NONE 値である必要があります。
Parameters	MERGE_VIRTUAL_DISK_PARAMETERS*	in	マージのパラメーターデータを格納する、有効な MERGE_VIRTUAL_DISK_PARAMETERS 構造体へのポインター。
Overlapped	OVERLAPPED*	inoptional	非同期操作を行う場合は、有効な OVERLAPPED 構造体への省略可能なポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

差分チェーン内の子仮想ハードディスク (VHD) を、そのチェーン内の 1 つ以上の親仮想ディスクにマージします。

戻り値

要求の状態。

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はエラーコードです。詳細については、システムエラーコードを参照してください。

解説(Remarks)

注意このセクションで使用するディスクという用語は、すべて仮想ディスクを指します。バッキングストアという用語は、VHD イメージファイルが格納されている物理ディスクストレージを指します。

MergeVirtualDisk 関数は、VirtualDiskHandle パラメーターで参照される子ディスクのデータブロックを使用して、1 つ以上の親ディスク内のすべてのデータブロックを更新します。これは本質的にコピー操作です。

ディスクをマージするには、操作中に対象のディスクがデタッチされている必要があります。

呼び出し元は、対象のディスクのバッキングストアに対する READ|WRITE アクセス権を持っている必要があります。

ディスクの RWDepth は、OPEN_VIRTUAL_DISK_PARAMETERS で指定されたマージの深さよりも大きい必要があります。

マージはマージ先の親ディスクを変更するため、その親に依存する他の差分ディスクは有効ではなくなります。

マージ先の親ディスクは、マージを実行した子差分ディスクが保持していたデータと同じデータを表すように変更されます。

マージ先の親ディスクに既存のデータがある場合、そのデータは上書きされます。

マージ操作が中断された場合でも、子ディスクは引き続き使用できます。MergeVirtualDisk 関数を再実行することで、マージを完了できます。

マージ要求の深さとは、マージ対象となる差分チェーン内の親 VHD イメージファイルの数です。たとえば、MergeDepth メンバーの値が 1 の場合、指定した差分ディスクのデータブロックはその親に移動されます。MergeDepth メンバーの値が 2 で、指定した差分ディスクの親も差分ディスクである場合 (つまり、チェーンに 3 つ目のディスクが存在する場合)、1 つ目と 2 つ目の両方のディスクのデータブロックが 3 つ目のディスクに移動されます (最終的な操作では、1 つ目のディスクのブロックが 2 つ目のディスクのブロックよりも優先されます)。

完了時、対象となった子ディスクは有効とは見なされなくなり、それらに対する以降の操作の結果はサポートされません。前述の例では、マージが正常に完了すると、3 つ目のディスクは有効ですが、1 つ目と 2 つ目は有効ではありません。MergeVirtualDisk 関数は、有効でなくなったディスクを削除したり、差分関係の再接続を自動的に行ったりはしません。これらは呼び出し元が明示的に行う必要があります。

差分ディスクの非リーフノードに対してマージ操作を実行した場合、マージされるディスクの子ノードの親情報を修正するのは呼び出し元の責任です。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

WIN32_ERROR MergeVirtualDisk(
    HANDLE VirtualDiskHandle,
    MERGE_VIRTUAL_DISK_FLAG Flags,
    MERGE_VIRTUAL_DISK_PARAMETERS* Parameters,
    OVERLAPPED* Overlapped   // optional
);

[DllImport("VirtDisk.dll", ExactSpelling = true)]
static extern uint MergeVirtualDisk(
    IntPtr VirtualDiskHandle,   // HANDLE
    int Flags,   // MERGE_VIRTUAL_DISK_FLAG
    IntPtr Parameters,   // MERGE_VIRTUAL_DISK_PARAMETERS*
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("VirtDisk.dll", ExactSpelling:=True)>
Public Shared Function MergeVirtualDisk(
    VirtualDiskHandle As IntPtr,   ' HANDLE
    Flags As Integer,   ' MERGE_VIRTUAL_DISK_FLAG
    Parameters As IntPtr,   ' MERGE_VIRTUAL_DISK_PARAMETERS*
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As UInteger
End Function

' VirtualDiskHandle : HANDLE
' Flags : MERGE_VIRTUAL_DISK_FLAG
' Parameters : MERGE_VIRTUAL_DISK_PARAMETERS*
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function MergeVirtualDisk 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

MergeVirtualDisk = ctypes.windll.virtdisk.MergeVirtualDisk
MergeVirtualDisk.restype = wintypes.DWORD
MergeVirtualDisk.argtypes = [
    wintypes.HANDLE,  # VirtualDiskHandle : HANDLE
    ctypes.c_int,  # Flags : MERGE_VIRTUAL_DISK_FLAG
    ctypes.c_void_p,  # Parameters : MERGE_VIRTUAL_DISK_PARAMETERS*
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VirtDisk.dll')
MergeVirtualDisk = Fiddle::Function.new(
  lib['MergeVirtualDisk'],
  [
    Fiddle::TYPE_VOIDP,  # VirtualDiskHandle : HANDLE
    Fiddle::TYPE_INT,  # Flags : MERGE_VIRTUAL_DISK_FLAG
    Fiddle::TYPE_VOIDP,  # Parameters : MERGE_VIRTUAL_DISK_PARAMETERS*
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "virtdisk")]
extern "system" {
    fn MergeVirtualDisk(
        VirtualDiskHandle: *mut core::ffi::c_void,  // HANDLE
        Flags: i32,  // MERGE_VIRTUAL_DISK_FLAG
        Parameters: *mut MERGE_VIRTUAL_DISK_PARAMETERS,  // MERGE_VIRTUAL_DISK_PARAMETERS*
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("VirtDisk.dll")]
public static extern uint MergeVirtualDisk(IntPtr VirtualDiskHandle, int Flags, IntPtr Parameters, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VirtDisk_MergeVirtualDisk' -Namespace Win32 -PassThru
# $api::MergeVirtualDisk(VirtualDiskHandle, Flags, Parameters, Overlapped)

#uselib "VirtDisk.dll"
#func global MergeVirtualDisk "MergeVirtualDisk" sptr, sptr, sptr, sptr
; MergeVirtualDisk VirtualDiskHandle, Flags, varptr(Parameters), varptr(Overlapped)   ; 戻り値は stat
; VirtualDiskHandle : HANDLE -> "sptr"
; Flags : MERGE_VIRTUAL_DISK_FLAG -> "sptr"
; Parameters : MERGE_VIRTUAL_DISK_PARAMETERS* -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "VirtDisk.dll"
#cfunc global MergeVirtualDisk "MergeVirtualDisk" sptr, int, var, var
; res = MergeVirtualDisk(VirtualDiskHandle, Flags, Parameters, Overlapped)
; VirtualDiskHandle : HANDLE -> "sptr"
; Flags : MERGE_VIRTUAL_DISK_FLAG -> "int"
; Parameters : MERGE_VIRTUAL_DISK_PARAMETERS* -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "VirtDisk.dll"
#cfunc global MergeVirtualDisk "MergeVirtualDisk" sptr, int, sptr, sptr
; res = MergeVirtualDisk(VirtualDiskHandle, Flags, varptr(Parameters), varptr(Overlapped))
; VirtualDiskHandle : HANDLE -> "sptr"
; Flags : MERGE_VIRTUAL_DISK_FLAG -> "int"
; Parameters : MERGE_VIRTUAL_DISK_PARAMETERS* -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。