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

VIRTUAL_DISK_PROGRESS

構造体
サイズx64: 24 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
OperationStatusDWORD4+0+0システム エラー コード の状態値です。操作がまだ進行中の場合、このメンバーは ERROR_IO_PENDING になります。それ以外の場合、値は完了した操作の結果コードです。
CurrentValueULONGLONG8+8+8

操作の現在の進行状況です。 CompletionValue メンバーと組み合わせて使用します。

この値は OperationStatusERROR_IO_PENDING の場合にのみ意味を持ちます。

CompletionValueULONGLONG8+16+16

操作が完了した場合に CurrentValue メンバーが取ることになる値です。

この値は OperationStatusERROR_IO_PENDING の場合にのみ意味を持ちます。

公式ドキュメント

現在の仮想ハード ディスク (VHD) 操作の進行状況と結果データを格納します。 GetVirtualDiskOperationProgress 関数で使用されます。

解説(Remarks)

CurrentValue メンバーと CompletionValue メンバーは、 パーセンテージ値を計算するために使用することを目的としており、それぞれの具体的な数値自体に意味はありません。意味を持つのは次の計算結果だけです。すなわち、 CurrentValueCompletionValue で除算して 100 を乗じた値が完了率であり、OperationStatus がまだ ERROR_IO_PENDING を返している場合でも、100 パーセントまで (100 パーセントを含む) の値になります。このパーセンテージは、 GetVirtualDiskOperationProgress 関数を後続で呼び出したときに必ず増加するとは限らず、減少することもあります。進行状況の追跡を増加方向のみで行いたい場合は、現在の最大パーセンテージをローカルに保存しておくことで、これらの減少したパーセンテージを無視しても問題ありません。

CurrentValue メンバーと CompletionValue メンバーは、 GetVirtualDiskOperationProgress 関数の後続の呼び出しで変化する可能性があるため、同じ呼び出しから同時に取得した値どうしを組み合わせて使用しなければなりません。つまり、いずれか一方をローカルに保存しておき、その後で GetVirtualDiskOperationProgress 関数を再度呼び出して、以前の値と新しい呼び出しで得たもう一方の値を組み合わせて使用することはできません。

完了の指標となるのは OperationStatus メンバーであり、前述のパーセンテージ計算ではありません。このデータ メンバーが ERROR_IO_PENDING 状態コードを返している間は、I/O 操作はまだ完了していません。

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

各言語での定義

#include <windows.h>

// VIRTUAL_DISK_PROGRESS  (x64 24 / x86 24 バイト)
typedef struct VIRTUAL_DISK_PROGRESS {
    DWORD OperationStatus;
    ULONGLONG CurrentValue;
    ULONGLONG CompletionValue;
} VIRTUAL_DISK_PROGRESS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct VIRTUAL_DISK_PROGRESS
{
    public uint OperationStatus;
    public ulong CurrentValue;
    public ulong CompletionValue;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure VIRTUAL_DISK_PROGRESS
    Public OperationStatus As UInteger
    Public CurrentValue As ULong
    Public CompletionValue As ULong
End Structure
import ctypes
from ctypes import wintypes

class VIRTUAL_DISK_PROGRESS(ctypes.Structure):
    _fields_ = [
        ("OperationStatus", wintypes.DWORD),
        ("CurrentValue", ctypes.c_ulonglong),
        ("CompletionValue", ctypes.c_ulonglong),
    ]
#[repr(C)]
pub struct VIRTUAL_DISK_PROGRESS {
    pub OperationStatus: u32,
    pub CurrentValue: u64,
    pub CompletionValue: u64,
}
import "golang.org/x/sys/windows"

type VIRTUAL_DISK_PROGRESS struct {
	OperationStatus uint32
	CurrentValue uint64
	CompletionValue uint64
}
type
  VIRTUAL_DISK_PROGRESS = record
    OperationStatus: DWORD;
    CurrentValue: UInt64;
    CompletionValue: UInt64;
  end;
const VIRTUAL_DISK_PROGRESS = extern struct {
    OperationStatus: u32,
    CurrentValue: u64,
    CompletionValue: u64,
};
type
  VIRTUAL_DISK_PROGRESS {.bycopy.} = object
    OperationStatus: uint32
    CurrentValue: uint64
    CompletionValue: uint64
struct VIRTUAL_DISK_PROGRESS
{
    uint OperationStatus;
    ulong CurrentValue;
    ulong CompletionValue;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; VIRTUAL_DISK_PROGRESS サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; OperationStatus : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; CurrentValue : ULONGLONG (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; CompletionValue : ULONGLONG (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global VIRTUAL_DISK_PROGRESS
    #field int OperationStatus
    #field int64 CurrentValue
    #field int64 CompletionValue
#endstruct

stdim st, VIRTUAL_DISK_PROGRESS        ; NSTRUCT 変数を確保
st->OperationStatus = 100
mes "OperationStatus=" + st->OperationStatus