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

GetVirtualDiskOperationProgress

関数
非同期の仮想ディスク操作の進捗状況を取得する。
DLLVirtDisk.dll呼出規約winapi対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetVirtualDiskOperationProgress(
    HANDLE VirtualDiskHandle,
    OVERLAPPED* Overlapped,
    VIRTUAL_DISK_PROGRESS* Progress
);

パラメーター

名前型方向説明
VirtualDiskHandleHANDLEin進行状況を取得する非同期操作中の仮想ディスクのハンドル。
OverlappedOVERLAPPED*in対象の非同期操作開始時に使用したOVERLAPPED構造体へのポインタ。どの操作かを識別する。
ProgressVIRTUAL_DISK_PROGRESS*out進捗情報を受け取るVIRTUAL_DISK_PROGRESS構造体へのポインタ。完了状況や現在値/合計値が返る。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

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

GetVirtualDiskOperationProgress = ctypes.windll.virtdisk.GetVirtualDiskOperationProgress
GetVirtualDiskOperationProgress.restype = wintypes.DWORD
GetVirtualDiskOperationProgress.argtypes = [
    wintypes.HANDLE,  # VirtualDiskHandle : HANDLE
    ctypes.c_void_p,  # Overlapped : OVERLAPPED*
    ctypes.c_void_p,  # Progress : VIRTUAL_DISK_PROGRESS* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	virtdisk = windows.NewLazySystemDLL("VirtDisk.dll")
	procGetVirtualDiskOperationProgress = virtdisk.NewProc("GetVirtualDiskOperationProgress")
)

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

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

typedef GetVirtualDiskOperationProgressNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef GetVirtualDiskOperationProgressDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final GetVirtualDiskOperationProgress = DynamicLibrary.open('VirtDisk.dll')
    .lookupFunction<GetVirtualDiskOperationProgressNative, GetVirtualDiskOperationProgressDart>('GetVirtualDiskOperationProgress');
// VirtualDiskHandle : HANDLE -> Pointer<Void>
// Overlapped : OVERLAPPED* -> Pointer<Void>
// Progress : VIRTUAL_DISK_PROGRESS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetVirtualDiskOperationProgress(
  VirtualDiskHandle: THandle;   // HANDLE
  Overlapped: Pointer;   // OVERLAPPED*
  Progress: Pointer   // VIRTUAL_DISK_PROGRESS* out
): DWORD; stdcall;
  external 'VirtDisk.dll' name 'GetVirtualDiskOperationProgress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetVirtualDiskOperationProgress"
  c_GetVirtualDiskOperationProgress :: Ptr () -> Ptr () -> Ptr () -> IO Word32
-- VirtualDiskHandle : HANDLE -> Ptr ()
-- Overlapped : OVERLAPPED* -> Ptr ()
-- Progress : VIRTUAL_DISK_PROGRESS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getvirtualdiskoperationprogress =
  foreign "GetVirtualDiskOperationProgress"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* VirtualDiskHandle : HANDLE -> (ptr void) *)
(* Overlapped : OVERLAPPED* -> (ptr void) *)
(* Progress : VIRTUAL_DISK_PROGRESS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library virtdisk (t "VirtDisk.dll"))
(cffi:use-foreign-library virtdisk)

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

関連項目

使用する型