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

LocateSavedStateFiles

関数
VMの保存状態ファイルのパスを検索して取得する。
DLLVmSavedStateDumpProvider.dll呼出規約winapi

シグネチャ

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

HRESULT LocateSavedStateFiles(
    LPCWSTR vmName,
    LPCWSTR snapshotName,   // optional
    LPWSTR* binPath,
    LPWSTR* vsvPath,
    LPWSTR* vmrsPath
);

パラメーター

名前方向説明
vmNameLPCWSTRin保存状態ファイルを探す対象の仮想マシン名を指定する文字列。
snapshotNameLPCWSTRinoptional対象とするスナップショット(チェックポイント)名を指定する文字列。NULL可。
binPathLPWSTR*out見つかったbinファイルのパス文字列を受け取る出力ポインタ。呼び出し側が解放する。
vsvPathLPWSTR*out見つかったvsvファイルのパス文字列を受け取る出力ポインタ。呼び出し側が解放する。
vmrsPathLPWSTR*out見つかったvmrsファイルのパス文字列を受け取る出力ポインタ。呼び出し側が解放する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT LocateSavedStateFiles(
    LPCWSTR vmName,
    LPCWSTR snapshotName,   // optional
    LPWSTR* binPath,
    LPWSTR* vsvPath,
    LPWSTR* vmrsPath
);
[DllImport("VmSavedStateDumpProvider.dll", ExactSpelling = true)]
static extern int LocateSavedStateFiles(
    [MarshalAs(UnmanagedType.LPWStr)] string vmName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string snapshotName,   // LPCWSTR optional
    IntPtr binPath,   // LPWSTR* out
    IntPtr vsvPath,   // LPWSTR* out
    IntPtr vmrsPath   // LPWSTR* out
);
<DllImport("VmSavedStateDumpProvider.dll", ExactSpelling:=True)>
Public Shared Function LocateSavedStateFiles(
    <MarshalAs(UnmanagedType.LPWStr)> vmName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> snapshotName As String,   ' LPCWSTR optional
    binPath As IntPtr,   ' LPWSTR* out
    vsvPath As IntPtr,   ' LPWSTR* out
    vmrsPath As IntPtr   ' LPWSTR* out
) As Integer
End Function
' vmName : LPCWSTR
' snapshotName : LPCWSTR optional
' binPath : LPWSTR* out
' vsvPath : LPWSTR* out
' vmrsPath : LPWSTR* out
Declare PtrSafe Function LocateSavedStateFiles Lib "vmsavedstatedumpprovider" ( _
    ByVal vmName As LongPtr, _
    ByVal snapshotName As LongPtr, _
    ByVal binPath As LongPtr, _
    ByVal vsvPath As LongPtr, _
    ByVal vmrsPath As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LocateSavedStateFiles = ctypes.windll.vmsavedstatedumpprovider.LocateSavedStateFiles
LocateSavedStateFiles.restype = ctypes.c_int
LocateSavedStateFiles.argtypes = [
    wintypes.LPCWSTR,  # vmName : LPCWSTR
    wintypes.LPCWSTR,  # snapshotName : LPCWSTR optional
    ctypes.c_void_p,  # binPath : LPWSTR* out
    ctypes.c_void_p,  # vsvPath : LPWSTR* out
    ctypes.c_void_p,  # vmrsPath : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('VmSavedStateDumpProvider.dll')
LocateSavedStateFiles = Fiddle::Function.new(
  lib['LocateSavedStateFiles'],
  [
    Fiddle::TYPE_VOIDP,  # vmName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # snapshotName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # binPath : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # vsvPath : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # vmrsPath : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "vmsavedstatedumpprovider")]
extern "system" {
    fn LocateSavedStateFiles(
        vmName: *const u16,  // LPCWSTR
        snapshotName: *const u16,  // LPCWSTR optional
        binPath: *mut *mut u16,  // LPWSTR* out
        vsvPath: *mut *mut u16,  // LPWSTR* out
        vmrsPath: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("VmSavedStateDumpProvider.dll")]
public static extern int LocateSavedStateFiles([MarshalAs(UnmanagedType.LPWStr)] string vmName, [MarshalAs(UnmanagedType.LPWStr)] string snapshotName, IntPtr binPath, IntPtr vsvPath, IntPtr vmrsPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'VmSavedStateDumpProvider_LocateSavedStateFiles' -Namespace Win32 -PassThru
# $api::LocateSavedStateFiles(vmName, snapshotName, binPath, vsvPath, vmrsPath)
#uselib "VmSavedStateDumpProvider.dll"
#func global LocateSavedStateFiles "LocateSavedStateFiles" sptr, sptr, sptr, sptr, sptr
; LocateSavedStateFiles vmName, snapshotName, varptr(binPath), varptr(vsvPath), varptr(vmrsPath)   ; 戻り値は stat
; vmName : LPCWSTR -> "sptr"
; snapshotName : LPCWSTR optional -> "sptr"
; binPath : LPWSTR* out -> "sptr"
; vsvPath : LPWSTR* out -> "sptr"
; vmrsPath : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "VmSavedStateDumpProvider.dll"
#cfunc global LocateSavedStateFiles "LocateSavedStateFiles" wstr, wstr, var, var, var
; res = LocateSavedStateFiles(vmName, snapshotName, binPath, vsvPath, vmrsPath)
; vmName : LPCWSTR -> "wstr"
; snapshotName : LPCWSTR optional -> "wstr"
; binPath : LPWSTR* out -> "var"
; vsvPath : LPWSTR* out -> "var"
; vmrsPath : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT LocateSavedStateFiles(LPCWSTR vmName, LPCWSTR snapshotName, LPWSTR* binPath, LPWSTR* vsvPath, LPWSTR* vmrsPath)
#uselib "VmSavedStateDumpProvider.dll"
#cfunc global LocateSavedStateFiles "LocateSavedStateFiles" wstr, wstr, var, var, var
; res = LocateSavedStateFiles(vmName, snapshotName, binPath, vsvPath, vmrsPath)
; vmName : LPCWSTR -> "wstr"
; snapshotName : LPCWSTR optional -> "wstr"
; binPath : LPWSTR* out -> "var"
; vsvPath : LPWSTR* out -> "var"
; vmrsPath : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	vmsavedstatedumpprovider = windows.NewLazySystemDLL("VmSavedStateDumpProvider.dll")
	procLocateSavedStateFiles = vmsavedstatedumpprovider.NewProc("LocateSavedStateFiles")
)

// vmName (LPCWSTR), snapshotName (LPCWSTR optional), binPath (LPWSTR* out), vsvPath (LPWSTR* out), vmrsPath (LPWSTR* out)
r1, _, err := procLocateSavedStateFiles.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(vmName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(snapshotName))),
	uintptr(binPath),
	uintptr(vsvPath),
	uintptr(vmrsPath),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function LocateSavedStateFiles(
  vmName: PWideChar;   // LPCWSTR
  snapshotName: PWideChar;   // LPCWSTR optional
  binPath: PPWideChar;   // LPWSTR* out
  vsvPath: PPWideChar;   // LPWSTR* out
  vmrsPath: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'VmSavedStateDumpProvider.dll' name 'LocateSavedStateFiles';
result := DllCall("VmSavedStateDumpProvider\LocateSavedStateFiles"
    , "WStr", vmName   ; LPCWSTR
    , "WStr", snapshotName   ; LPCWSTR optional
    , "Ptr", binPath   ; LPWSTR* out
    , "Ptr", vsvPath   ; LPWSTR* out
    , "Ptr", vmrsPath   ; LPWSTR* out
    , "Int")   ; return: HRESULT
●LocateSavedStateFiles(vmName, snapshotName, binPath, vsvPath, vmrsPath) = DLL("VmSavedStateDumpProvider.dll", "int LocateSavedStateFiles(char*, char*, void*, void*, void*)")
# 呼び出し: LocateSavedStateFiles(vmName, snapshotName, binPath, vsvPath, vmrsPath)
# vmName : LPCWSTR -> "char*"
# snapshotName : LPCWSTR optional -> "char*"
# binPath : LPWSTR* out -> "void*"
# vsvPath : LPWSTR* out -> "void*"
# vmrsPath : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef LocateSavedStateFilesNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
typedef LocateSavedStateFilesDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
final LocateSavedStateFiles = DynamicLibrary.open('VmSavedStateDumpProvider.dll')
    .lookupFunction<LocateSavedStateFilesNative, LocateSavedStateFilesDart>('LocateSavedStateFiles');
// vmName : LPCWSTR -> Pointer<Utf16>
// snapshotName : LPCWSTR optional -> Pointer<Utf16>
// binPath : LPWSTR* out -> Pointer<Pointer<Utf16>>
// vsvPath : LPWSTR* out -> Pointer<Pointer<Utf16>>
// vmrsPath : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LocateSavedStateFiles(
  vmName: PWideChar;   // LPCWSTR
  snapshotName: PWideChar;   // LPCWSTR optional
  binPath: PPWideChar;   // LPWSTR* out
  vsvPath: PPWideChar;   // LPWSTR* out
  vmrsPath: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'VmSavedStateDumpProvider.dll' name 'LocateSavedStateFiles';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LocateSavedStateFiles"
  c_LocateSavedStateFiles :: CWString -> CWString -> Ptr CWString -> Ptr CWString -> Ptr CWString -> IO Int32
-- vmName : LPCWSTR -> CWString
-- snapshotName : LPCWSTR optional -> CWString
-- binPath : LPWSTR* out -> Ptr CWString
-- vsvPath : LPWSTR* out -> Ptr CWString
-- vmrsPath : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let locatesavedstatefiles =
  foreign "LocateSavedStateFiles"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> (ptr (ptr uint16_t)) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* vmName : LPCWSTR -> (ptr uint16_t) *)
(* snapshotName : LPCWSTR optional -> (ptr uint16_t) *)
(* binPath : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* vsvPath : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* vmrsPath : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library vmsavedstatedumpprovider (t "VmSavedStateDumpProvider.dll"))
(cffi:use-foreign-library vmsavedstatedumpprovider)

(cffi:defcfun ("LocateSavedStateFiles" locate-saved-state-files :convention :stdcall) :int32
  (vm-name (:string :encoding :utf-16le))   ; LPCWSTR
  (snapshot-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (bin-path :pointer)   ; LPWSTR* out
  (vsv-path :pointer)   ; LPWSTR* out
  (vmrs-path :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocateSavedStateFiles = Win32::API::More->new('VmSavedStateDumpProvider',
    'int LocateSavedStateFiles(LPCWSTR vmName, LPCWSTR snapshotName, LPVOID binPath, LPVOID vsvPath, LPVOID vmrsPath)');
# my $ret = $LocateSavedStateFiles->Call($vmName, $snapshotName, $binPath, $vsvPath, $vmrsPath);
# vmName : LPCWSTR -> LPCWSTR
# snapshotName : LPCWSTR optional -> LPCWSTR
# binPath : LPWSTR* out -> LPVOID
# vsvPath : LPWSTR* out -> LPVOID
# vmrsPath : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。