Win32 API 日本語リファレンス
ホームSystem.Diagnostics.ProcessSnapshotting › PssCaptureSnapshot

PssCaptureSnapshot

関数
プロセスの状態スナップショットをキャプチャする。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

DWORD PssCaptureSnapshot(
    HANDLE ProcessHandle,
    PSS_CAPTURE_FLAGS CaptureFlags,
    DWORD ThreadContextFlags,   // optional
    HPSS* SnapshotHandle
);

パラメーター

名前方向説明
ProcessHandleHANDLEinスナップショットを取得する対象プロセスのハンドル。適切なアクセス権が必要。
CaptureFlagsPSS_CAPTURE_FLAGSin取得する情報の種類を指定するPSS_CAPTURE_FLAGSビットフラグ。
ThreadContextFlagsDWORDinoptionalスレッドコンテキスト取得時に使うCONTEXTフラグ。コンテキスト取得を指定した場合のみ有効。
SnapshotHandleHPSS*out作成されたスナップショットのHPSSハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PssCaptureSnapshot(
    HANDLE ProcessHandle,
    PSS_CAPTURE_FLAGS CaptureFlags,
    DWORD ThreadContextFlags,   // optional
    HPSS* SnapshotHandle
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint PssCaptureSnapshot(
    IntPtr ProcessHandle,   // HANDLE
    uint CaptureFlags,   // PSS_CAPTURE_FLAGS
    uint ThreadContextFlags,   // DWORD optional
    IntPtr SnapshotHandle   // HPSS* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function PssCaptureSnapshot(
    ProcessHandle As IntPtr,   ' HANDLE
    CaptureFlags As UInteger,   ' PSS_CAPTURE_FLAGS
    ThreadContextFlags As UInteger,   ' DWORD optional
    SnapshotHandle As IntPtr   ' HPSS* out
) As UInteger
End Function
' ProcessHandle : HANDLE
' CaptureFlags : PSS_CAPTURE_FLAGS
' ThreadContextFlags : DWORD optional
' SnapshotHandle : HPSS* out
Declare PtrSafe Function PssCaptureSnapshot Lib "kernel32" ( _
    ByVal ProcessHandle As LongPtr, _
    ByVal CaptureFlags As Long, _
    ByVal ThreadContextFlags As Long, _
    ByVal SnapshotHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PssCaptureSnapshot = ctypes.windll.kernel32.PssCaptureSnapshot
PssCaptureSnapshot.restype = wintypes.DWORD
PssCaptureSnapshot.argtypes = [
    wintypes.HANDLE,  # ProcessHandle : HANDLE
    wintypes.DWORD,  # CaptureFlags : PSS_CAPTURE_FLAGS
    wintypes.DWORD,  # ThreadContextFlags : DWORD optional
    ctypes.c_void_p,  # SnapshotHandle : HPSS* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PssCaptureSnapshot = Fiddle::Function.new(
  lib['PssCaptureSnapshot'],
  [
    Fiddle::TYPE_VOIDP,  # ProcessHandle : HANDLE
    -Fiddle::TYPE_INT,  # CaptureFlags : PSS_CAPTURE_FLAGS
    -Fiddle::TYPE_INT,  # ThreadContextFlags : DWORD optional
    Fiddle::TYPE_VOIDP,  # SnapshotHandle : HPSS* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn PssCaptureSnapshot(
        ProcessHandle: *mut core::ffi::c_void,  // HANDLE
        CaptureFlags: u32,  // PSS_CAPTURE_FLAGS
        ThreadContextFlags: u32,  // DWORD optional
        SnapshotHandle: *mut *mut core::ffi::c_void  // HPSS* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint PssCaptureSnapshot(IntPtr ProcessHandle, uint CaptureFlags, uint ThreadContextFlags, IntPtr SnapshotHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PssCaptureSnapshot' -Namespace Win32 -PassThru
# $api::PssCaptureSnapshot(ProcessHandle, CaptureFlags, ThreadContextFlags, SnapshotHandle)
#uselib "KERNEL32.dll"
#func global PssCaptureSnapshot "PssCaptureSnapshot" sptr, sptr, sptr, sptr
; PssCaptureSnapshot ProcessHandle, CaptureFlags, ThreadContextFlags, SnapshotHandle   ; 戻り値は stat
; ProcessHandle : HANDLE -> "sptr"
; CaptureFlags : PSS_CAPTURE_FLAGS -> "sptr"
; ThreadContextFlags : DWORD optional -> "sptr"
; SnapshotHandle : HPSS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global PssCaptureSnapshot "PssCaptureSnapshot" sptr, int, int, sptr
; res = PssCaptureSnapshot(ProcessHandle, CaptureFlags, ThreadContextFlags, SnapshotHandle)
; ProcessHandle : HANDLE -> "sptr"
; CaptureFlags : PSS_CAPTURE_FLAGS -> "int"
; ThreadContextFlags : DWORD optional -> "int"
; SnapshotHandle : HPSS* out -> "sptr"
; DWORD PssCaptureSnapshot(HANDLE ProcessHandle, PSS_CAPTURE_FLAGS CaptureFlags, DWORD ThreadContextFlags, HPSS* SnapshotHandle)
#uselib "KERNEL32.dll"
#cfunc global PssCaptureSnapshot "PssCaptureSnapshot" intptr, int, int, intptr
; res = PssCaptureSnapshot(ProcessHandle, CaptureFlags, ThreadContextFlags, SnapshotHandle)
; ProcessHandle : HANDLE -> "intptr"
; CaptureFlags : PSS_CAPTURE_FLAGS -> "int"
; ThreadContextFlags : DWORD optional -> "int"
; SnapshotHandle : HPSS* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPssCaptureSnapshot = kernel32.NewProc("PssCaptureSnapshot")
)

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

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

typedef PssCaptureSnapshotNative = Uint32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef PssCaptureSnapshotDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final PssCaptureSnapshot = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PssCaptureSnapshotNative, PssCaptureSnapshotDart>('PssCaptureSnapshot');
// ProcessHandle : HANDLE -> Pointer<Void>
// CaptureFlags : PSS_CAPTURE_FLAGS -> Uint32
// ThreadContextFlags : DWORD optional -> Uint32
// SnapshotHandle : HPSS* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PssCaptureSnapshot(
  ProcessHandle: THandle;   // HANDLE
  CaptureFlags: DWORD;   // PSS_CAPTURE_FLAGS
  ThreadContextFlags: DWORD;   // DWORD optional
  SnapshotHandle: Pointer   // HPSS* out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'PssCaptureSnapshot';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PssCaptureSnapshot"
  c_PssCaptureSnapshot :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO Word32
-- ProcessHandle : HANDLE -> Ptr ()
-- CaptureFlags : PSS_CAPTURE_FLAGS -> Word32
-- ThreadContextFlags : DWORD optional -> Word32
-- SnapshotHandle : HPSS* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let psscapturesnapshot =
  foreign "PssCaptureSnapshot"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ProcessHandle : HANDLE -> (ptr void) *)
(* CaptureFlags : PSS_CAPTURE_FLAGS -> uint32_t *)
(* ThreadContextFlags : DWORD optional -> uint32_t *)
(* SnapshotHandle : HPSS* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("PssCaptureSnapshot" pss-capture-snapshot :convention :stdcall) :uint32
  (process-handle :pointer)   ; HANDLE
  (capture-flags :uint32)   ; PSS_CAPTURE_FLAGS
  (thread-context-flags :uint32)   ; DWORD optional
  (snapshot-handle :pointer))   ; HPSS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PssCaptureSnapshot = Win32::API::More->new('KERNEL32',
    'DWORD PssCaptureSnapshot(HANDLE ProcessHandle, DWORD CaptureFlags, DWORD ThreadContextFlags, HANDLE SnapshotHandle)');
# my $ret = $PssCaptureSnapshot->Call($ProcessHandle, $CaptureFlags, $ThreadContextFlags, $SnapshotHandle);
# ProcessHandle : HANDLE -> HANDLE
# CaptureFlags : PSS_CAPTURE_FLAGS -> DWORD
# ThreadContextFlags : DWORD optional -> DWORD
# SnapshotHandle : HPSS* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型