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

CreateToolhelp32Snapshot

関数
指定プロセスのプロセスやスレッド等のスナップショットを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

HANDLE CreateToolhelp32Snapshot(
    CREATE_TOOLHELP_SNAPSHOT_FLAGS dwFlags,
    DWORD th32ProcessID
);

パラメーター

名前方向説明
dwFlagsCREATE_TOOLHELP_SNAPSHOT_FLAGSin取得対象(プロセス/スレッド/モジュール/ヒープ)を指定するCREATE_TOOLHELP_SNAPSHOT_FLAGSビットフラグ。
th32ProcessIDDWORDin対象プロセスのID。モジュール/ヒープ列挙で使用。0で現在のプロセスを指す。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE CreateToolhelp32Snapshot(
    CREATE_TOOLHELP_SNAPSHOT_FLAGS dwFlags,
    DWORD th32ProcessID
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateToolhelp32Snapshot(
    uint dwFlags,   // CREATE_TOOLHELP_SNAPSHOT_FLAGS
    uint th32ProcessID   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateToolhelp32Snapshot(
    dwFlags As UInteger,   ' CREATE_TOOLHELP_SNAPSHOT_FLAGS
    th32ProcessID As UInteger   ' DWORD
) As IntPtr
End Function
' dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS
' th32ProcessID : DWORD
Declare PtrSafe Function CreateToolhelp32Snapshot Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal th32ProcessID As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateToolhelp32Snapshot = ctypes.windll.kernel32.CreateToolhelp32Snapshot
CreateToolhelp32Snapshot.restype = ctypes.c_void_p
CreateToolhelp32Snapshot.argtypes = [
    wintypes.DWORD,  # dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS
    wintypes.DWORD,  # th32ProcessID : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateToolhelp32Snapshot = kernel32.NewProc("CreateToolhelp32Snapshot")
)

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

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

typedef CreateToolhelp32SnapshotNative = Pointer<Void> Function(Uint32, Uint32);
typedef CreateToolhelp32SnapshotDart = Pointer<Void> Function(int, int);
final CreateToolhelp32Snapshot = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateToolhelp32SnapshotNative, CreateToolhelp32SnapshotDart>('CreateToolhelp32Snapshot');
// dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS -> Uint32
// th32ProcessID : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateToolhelp32Snapshot(
  dwFlags: DWORD;   // CREATE_TOOLHELP_SNAPSHOT_FLAGS
  th32ProcessID: DWORD   // DWORD
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateToolhelp32Snapshot';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateToolhelp32Snapshot"
  c_CreateToolhelp32Snapshot :: Word32 -> Word32 -> IO (Ptr ())
-- dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS -> Word32
-- th32ProcessID : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createtoolhelp32snapshot =
  foreign "CreateToolhelp32Snapshot"
    (uint32_t @-> uint32_t @-> returning (ptr void))
(* dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS -> uint32_t *)
(* th32ProcessID : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateToolhelp32Snapshot" create-toolhelp32-snapshot :convention :stdcall) :pointer
  (dw-flags :uint32)   ; CREATE_TOOLHELP_SNAPSHOT_FLAGS
  (th32-process-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateToolhelp32Snapshot = Win32::API::More->new('KERNEL32',
    'HANDLE CreateToolhelp32Snapshot(DWORD dwFlags, DWORD th32ProcessID)');
# my $ret = $CreateToolhelp32Snapshot->Call($dwFlags, $th32ProcessID);
# dwFlags : CREATE_TOOLHELP_SNAPSHOT_FLAGS -> DWORD
# th32ProcessID : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型