Win32 API 日本語リファレンス
ホーム › System.Hypervisor › WHvGetVirtualProcessorState

WHvGetVirtualProcessorState

関数
仮想プロセッサの指定種別の状態を取得する。
DLLWinHvPlatform.dll呼出規約winapi

シグネチャ

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

HRESULT WHvGetVirtualProcessorState(
    WHV_PARTITION_HANDLE Partition,
    DWORD VpIndex,
    WHV_VIRTUAL_PROCESSOR_STATE_TYPE StateType,
    void* Buffer,
    DWORD BufferSizeInBytes,
    DWORD* BytesWritten   // optional
);

パラメーター

名前型方向説明
PartitionWHV_PARTITION_HANDLEin対象パーティションのハンドルを指定する。
VpIndexDWORDin対象とする仮想プロセッサの0始まりのインデックス番号を指定する。
StateTypeWHV_VIRTUAL_PROCESSOR_STATE_TYPEin取得する仮想プロセッサ状態の種類を示す列挙値を指定する。
Buffervoid*out状態データを受け取る出力バッファへのポインタ。
BufferSizeInBytesDWORDinBufferが指すバッファのバイト単位のサイズを指定する。
BytesWrittenDWORD*outoptional実際に書き込まれたバイト数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WHvGetVirtualProcessorState(
    WHV_PARTITION_HANDLE Partition,
    DWORD VpIndex,
    WHV_VIRTUAL_PROCESSOR_STATE_TYPE StateType,
    void* Buffer,
    DWORD BufferSizeInBytes,
    DWORD* BytesWritten   // optional
);
[DllImport("WinHvPlatform.dll", ExactSpelling = true)]
static extern int WHvGetVirtualProcessorState(
    IntPtr Partition,   // WHV_PARTITION_HANDLE
    uint VpIndex,   // DWORD
    int StateType,   // WHV_VIRTUAL_PROCESSOR_STATE_TYPE
    IntPtr Buffer,   // void* out
    uint BufferSizeInBytes,   // DWORD
    IntPtr BytesWritten   // DWORD* optional, out
);
<DllImport("WinHvPlatform.dll", ExactSpelling:=True)>
Public Shared Function WHvGetVirtualProcessorState(
    Partition As IntPtr,   ' WHV_PARTITION_HANDLE
    VpIndex As UInteger,   ' DWORD
    StateType As Integer,   ' WHV_VIRTUAL_PROCESSOR_STATE_TYPE
    Buffer As IntPtr,   ' void* out
    BufferSizeInBytes As UInteger,   ' DWORD
    BytesWritten As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' Partition : WHV_PARTITION_HANDLE
' VpIndex : DWORD
' StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE
' Buffer : void* out
' BufferSizeInBytes : DWORD
' BytesWritten : DWORD* optional, out
Declare PtrSafe Function WHvGetVirtualProcessorState Lib "winhvplatform" ( _
    ByVal Partition As LongPtr, _
    ByVal VpIndex As Long, _
    ByVal StateType As Long, _
    ByVal Buffer As LongPtr, _
    ByVal BufferSizeInBytes As Long, _
    ByVal BytesWritten As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WHvGetVirtualProcessorState = ctypes.windll.winhvplatform.WHvGetVirtualProcessorState
WHvGetVirtualProcessorState.restype = ctypes.c_int
WHvGetVirtualProcessorState.argtypes = [
    ctypes.c_ssize_t,  # Partition : WHV_PARTITION_HANDLE
    wintypes.DWORD,  # VpIndex : DWORD
    ctypes.c_int,  # StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE
    ctypes.POINTER(None),  # Buffer : void* out
    wintypes.DWORD,  # BufferSizeInBytes : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesWritten : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WinHvPlatform.dll')
WHvGetVirtualProcessorState = Fiddle::Function.new(
  lib['WHvGetVirtualProcessorState'],
  [
    Fiddle::TYPE_INTPTR_T,  # Partition : WHV_PARTITION_HANDLE
    -Fiddle::TYPE_INT,  # VpIndex : DWORD
    Fiddle::TYPE_INT,  # StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE
    Fiddle::TYPE_VOIDP,  # Buffer : void* out
    -Fiddle::TYPE_INT,  # BufferSizeInBytes : DWORD
    Fiddle::TYPE_VOIDP,  # BytesWritten : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winhvplatform")]
extern "system" {
    fn WHvGetVirtualProcessorState(
        Partition: isize,  // WHV_PARTITION_HANDLE
        VpIndex: u32,  // DWORD
        StateType: i32,  // WHV_VIRTUAL_PROCESSOR_STATE_TYPE
        Buffer: *mut (),  // void* out
        BufferSizeInBytes: u32,  // DWORD
        BytesWritten: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WinHvPlatform.dll")]
public static extern int WHvGetVirtualProcessorState(IntPtr Partition, uint VpIndex, int StateType, IntPtr Buffer, uint BufferSizeInBytes, IntPtr BytesWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WinHvPlatform_WHvGetVirtualProcessorState' -Namespace Win32 -PassThru
# $api::WHvGetVirtualProcessorState(Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, BytesWritten)
#uselib "WinHvPlatform.dll"
#func global WHvGetVirtualProcessorState "WHvGetVirtualProcessorState" sptr, sptr, sptr, sptr, sptr, sptr
; WHvGetVirtualProcessorState Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, varptr(BytesWritten)   ; 戻り値は stat
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; VpIndex : DWORD -> "sptr"
; StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> "sptr"
; Buffer : void* out -> "sptr"
; BufferSizeInBytes : DWORD -> "sptr"
; BytesWritten : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "WinHvPlatform.dll"
#cfunc global WHvGetVirtualProcessorState "WHvGetVirtualProcessorState" sptr, int, int, sptr, int, var
; res = WHvGetVirtualProcessorState(Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, BytesWritten)
; Partition : WHV_PARTITION_HANDLE -> "sptr"
; VpIndex : DWORD -> "int"
; StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> "int"
; Buffer : void* out -> "sptr"
; BufferSizeInBytes : DWORD -> "int"
; BytesWritten : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT WHvGetVirtualProcessorState(WHV_PARTITION_HANDLE Partition, DWORD VpIndex, WHV_VIRTUAL_PROCESSOR_STATE_TYPE StateType, void* Buffer, DWORD BufferSizeInBytes, DWORD* BytesWritten)
#uselib "WinHvPlatform.dll"
#cfunc global WHvGetVirtualProcessorState "WHvGetVirtualProcessorState" intptr, int, int, intptr, int, var
; res = WHvGetVirtualProcessorState(Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, BytesWritten)
; Partition : WHV_PARTITION_HANDLE -> "intptr"
; VpIndex : DWORD -> "int"
; StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> "int"
; Buffer : void* out -> "intptr"
; BufferSizeInBytes : DWORD -> "int"
; BytesWritten : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhvplatform = windows.NewLazySystemDLL("WinHvPlatform.dll")
	procWHvGetVirtualProcessorState = winhvplatform.NewProc("WHvGetVirtualProcessorState")
)

// Partition (WHV_PARTITION_HANDLE), VpIndex (DWORD), StateType (WHV_VIRTUAL_PROCESSOR_STATE_TYPE), Buffer (void* out), BufferSizeInBytes (DWORD), BytesWritten (DWORD* optional, out)
r1, _, err := procWHvGetVirtualProcessorState.Call(
	uintptr(Partition),
	uintptr(VpIndex),
	uintptr(StateType),
	uintptr(Buffer),
	uintptr(BufferSizeInBytes),
	uintptr(BytesWritten),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WHvGetVirtualProcessorState(
  Partition: NativeInt;   // WHV_PARTITION_HANDLE
  VpIndex: DWORD;   // DWORD
  StateType: Integer;   // WHV_VIRTUAL_PROCESSOR_STATE_TYPE
  Buffer: Pointer;   // void* out
  BufferSizeInBytes: DWORD;   // DWORD
  BytesWritten: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'WinHvPlatform.dll' name 'WHvGetVirtualProcessorState';
result := DllCall("WinHvPlatform\WHvGetVirtualProcessorState"
    , "Ptr", Partition   ; WHV_PARTITION_HANDLE
    , "UInt", VpIndex   ; DWORD
    , "Int", StateType   ; WHV_VIRTUAL_PROCESSOR_STATE_TYPE
    , "Ptr", Buffer   ; void* out
    , "UInt", BufferSizeInBytes   ; DWORD
    , "Ptr", BytesWritten   ; DWORD* optional, out
    , "Int")   ; return: HRESULT
●WHvGetVirtualProcessorState(Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, BytesWritten) = DLL("WinHvPlatform.dll", "int WHvGetVirtualProcessorState(int, dword, int, void*, dword, void*)")
# 呼び出し: WHvGetVirtualProcessorState(Partition, VpIndex, StateType, Buffer, BufferSizeInBytes, BytesWritten)
# Partition : WHV_PARTITION_HANDLE -> "int"
# VpIndex : DWORD -> "dword"
# StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> "int"
# Buffer : void* out -> "void*"
# BufferSizeInBytes : DWORD -> "dword"
# BytesWritten : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WHvGetVirtualProcessorStateNative = Int32 Function(IntPtr, Uint32, Int32, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef WHvGetVirtualProcessorStateDart = int Function(int, int, int, Pointer<Void>, int, Pointer<Uint32>);
final WHvGetVirtualProcessorState = DynamicLibrary.open('WinHvPlatform.dll')
    .lookupFunction<WHvGetVirtualProcessorStateNative, WHvGetVirtualProcessorStateDart>('WHvGetVirtualProcessorState');
// Partition : WHV_PARTITION_HANDLE -> IntPtr
// VpIndex : DWORD -> Uint32
// StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> Int32
// Buffer : void* out -> Pointer<Void>
// BufferSizeInBytes : DWORD -> Uint32
// BytesWritten : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WHvGetVirtualProcessorState(
  Partition: NativeInt;   // WHV_PARTITION_HANDLE
  VpIndex: DWORD;   // DWORD
  StateType: Integer;   // WHV_VIRTUAL_PROCESSOR_STATE_TYPE
  Buffer: Pointer;   // void* out
  BufferSizeInBytes: DWORD;   // DWORD
  BytesWritten: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'WinHvPlatform.dll' name 'WHvGetVirtualProcessorState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WHvGetVirtualProcessorState"
  c_WHvGetVirtualProcessorState :: CIntPtr -> Word32 -> Int32 -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- Partition : WHV_PARTITION_HANDLE -> CIntPtr
-- VpIndex : DWORD -> Word32
-- StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> Int32
-- Buffer : void* out -> Ptr ()
-- BufferSizeInBytes : DWORD -> Word32
-- BytesWritten : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let whvgetvirtualprocessorstate =
  foreign "WHvGetVirtualProcessorState"
    (intptr_t @-> uint32_t @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* Partition : WHV_PARTITION_HANDLE -> intptr_t *)
(* VpIndex : DWORD -> uint32_t *)
(* StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> int32_t *)
(* Buffer : void* out -> (ptr void) *)
(* BufferSizeInBytes : DWORD -> uint32_t *)
(* BytesWritten : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhvplatform (t "WinHvPlatform.dll"))
(cffi:use-foreign-library winhvplatform)

(cffi:defcfun ("WHvGetVirtualProcessorState" whv-get-virtual-processor-state :convention :stdcall) :int32
  (partition :int64)   ; WHV_PARTITION_HANDLE
  (vp-index :uint32)   ; DWORD
  (state-type :int32)   ; WHV_VIRTUAL_PROCESSOR_STATE_TYPE
  (buffer :pointer)   ; void* out
  (buffer-size-in-bytes :uint32)   ; DWORD
  (bytes-written :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WHvGetVirtualProcessorState = Win32::API::More->new('WinHvPlatform',
    'int WHvGetVirtualProcessorState(LPARAM Partition, DWORD VpIndex, int StateType, LPVOID Buffer, DWORD BufferSizeInBytes, LPVOID BytesWritten)');
# my $ret = $WHvGetVirtualProcessorState->Call($Partition, $VpIndex, $StateType, $Buffer, $BufferSizeInBytes, $BytesWritten);
# Partition : WHV_PARTITION_HANDLE -> LPARAM
# VpIndex : DWORD -> DWORD
# StateType : WHV_VIRTUAL_PROCESSOR_STATE_TYPE -> int
# Buffer : void* out -> LPVOID
# BufferSizeInBytes : DWORD -> DWORD
# BytesWritten : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型