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

SymEnumTypes

関数
モジュール内の型シンボルを列挙する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymEnumTypes(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
    void* UserContext   // optional
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDllULONGLONGinモジュールのベースアドレス。
EnumSymbolsCallbackPSYM_ENUMERATESYMBOLS_CALLBACKinシンボル情報を受け取る SymEnumSymbolsProc コールバック関数へのポインター。
UserContextvoid*inoptionalコールバック関数に渡されるユーザー定義の値、または NULL。このパラメーターは通常、コールバック関数にコンテキスト情報を提供するデータ構造へのポインターをアプリケーションが渡すために使用されます。

戻り値の型: BOOL

公式ドキュメント

SymEnumTypes 関数 (dbghelp.h) は、すべてのユーザー定義型を列挙します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

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

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymEnumTypes(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
    void* UserContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymEnumTypes(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    IntPtr EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACK
    IntPtr UserContext   // void* optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymEnumTypes(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    EnumSymbolsCallback As IntPtr,   ' PSYM_ENUMERATESYMBOLS_CALLBACK
    UserContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK
' UserContext : void* optional
Declare PtrSafe Function SymEnumTypes Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal EnumSymbolsCallback As LongPtr, _
    ByVal UserContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymEnumTypes = ctypes.windll.dbghelp.SymEnumTypes
SymEnumTypes.restype = wintypes.BOOL
SymEnumTypes.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    ctypes.c_void_p,  # EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK
    ctypes.POINTER(None),  # UserContext : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymEnumTypes = Fiddle::Function.new(
  lib['SymEnumTypes'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    Fiddle::TYPE_VOIDP,  # EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK
    Fiddle::TYPE_VOIDP,  # UserContext : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymEnumTypes(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        EnumSymbolsCallback: *const core::ffi::c_void,  // PSYM_ENUMERATESYMBOLS_CALLBACK
        UserContext: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SymEnumTypes(IntPtr hProcess, ulong BaseOfDll, IntPtr EnumSymbolsCallback, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymEnumTypes' -Namespace Win32 -PassThru
# $api::SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
#uselib "dbghelp.dll"
#func global SymEnumTypes "SymEnumTypes" sptr, sptr, sptr, sptr
; SymEnumTypes hProcess, BaseOfDll, EnumSymbolsCallback, UserContext   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "sptr"
; EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> "sptr"
; UserContext : void* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymEnumTypes "SymEnumTypes" sptr, int64, sptr, sptr
; res = SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> "sptr"
; UserContext : void* optional -> "sptr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOL SymEnumTypes(HANDLE hProcess, ULONGLONG BaseOfDll, PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback, void* UserContext)
#uselib "dbghelp.dll"
#cfunc global SymEnumTypes "SymEnumTypes" intptr, int64, intptr, intptr
; res = SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : ULONGLONG -> "int64"
; EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> "intptr"
; UserContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumTypes = dbghelp.NewProc("SymEnumTypes")
)

// hProcess (HANDLE), BaseOfDll (ULONGLONG), EnumSymbolsCallback (PSYM_ENUMERATESYMBOLS_CALLBACK), UserContext (void* optional)
r1, _, err := procSymEnumTypes.Call(
	uintptr(hProcess),
	uintptr(BaseOfDll),
	uintptr(EnumSymbolsCallback),
	uintptr(UserContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymEnumTypes(
  hProcess: THandle;   // HANDLE
  BaseOfDll: UInt64;   // ULONGLONG
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMERATESYMBOLS_CALLBACK
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumTypes';
result := DllCall("dbghelp\SymEnumTypes"
    , "Ptr", hProcess   ; HANDLE
    , "Int64", BaseOfDll   ; ULONGLONG
    , "Ptr", EnumSymbolsCallback   ; PSYM_ENUMERATESYMBOLS_CALLBACK
    , "Ptr", UserContext   ; void* optional
    , "Int")   ; return: BOOL
●SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext) = DLL("dbghelp.dll", "bool SymEnumTypes(void*, qword, void*, void*)")
# 呼び出し: SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> "void*"
# BaseOfDll : ULONGLONG -> "qword"
# EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> "void*"
# UserContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymEnumTypes(
    hProcess: ?*anyopaque, // HANDLE
    BaseOfDll: u64, // ULONGLONG
    EnumSymbolsCallback: ?*anyopaque, // PSYM_ENUMERATESYMBOLS_CALLBACK
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc SymEnumTypes(
    hProcess: pointer,  # HANDLE
    BaseOfDll: uint64,  # ULONGLONG
    EnumSymbolsCallback: pointer,  # PSYM_ENUMERATESYMBOLS_CALLBACK
    UserContext: pointer  # void* optional
): int32 {.importc: "SymEnumTypes", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymEnumTypes(
    void* hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    void* EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACK
    void* UserContext   // void* optional
);
ccall((:SymEnumTypes, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# BaseOfDll : ULONGLONG -> UInt64
# EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> Ptr{Cvoid}
# UserContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymEnumTypes(
    void* hProcess,
    uint64_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
-- hProcess : HANDLE
-- BaseOfDll : ULONGLONG
-- EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK
-- UserContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymEnumTypes = lib.func('__stdcall', 'SymEnumTypes', 'int32_t', ['void *', 'uint64_t', 'void *', 'void *']);
// SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> 'void *'
// BaseOfDll : ULONGLONG -> 'uint64_t'
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymEnumTypes: { parameters: ["pointer", "u64", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> "pointer"
// BaseOfDll : ULONGLONG -> "u64"
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> "pointer"
// UserContext : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymEnumTypes(
    void* hProcess,
    uint64_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymEnumTypes(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext);
// hProcess : HANDLE
// BaseOfDll : ULONGLONG
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK
// UserContext : void* optional
// 構造体/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 Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.ASCII_OPTIONS);
    boolean SymEnumTypes(
        Pointer hProcess,   // HANDLE
        long BaseOfDll,   // ULONGLONG
        Callback EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACK
        Pointer UserContext   // void* optional
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymEnumTypes = SymEnumTypes(
    hProcess : Void*,   # HANDLE
    BaseOfDll : UInt64,   # ULONGLONG
    EnumSymbolsCallback : Void*,   # PSYM_ENUMERATESYMBOLS_CALLBACK
    UserContext : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymEnumTypesNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Void>, Pointer<Void>);
typedef SymEnumTypesDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final SymEnumTypes = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumTypesNative, SymEnumTypesDart>('SymEnumTypes');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : ULONGLONG -> Uint64
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumTypes(
  hProcess: THandle;   // HANDLE
  BaseOfDll: UInt64;   // ULONGLONG
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMERATESYMBOLS_CALLBACK
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumTypes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymEnumTypes"
  c_SymEnumTypes :: Ptr () -> Word64 -> Ptr () -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- BaseOfDll : ULONGLONG -> Word64
-- EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> Ptr ()
-- UserContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symenumtypes =
  foreign "SymEnumTypes"
    ((ptr void) @-> uint64_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* BaseOfDll : ULONGLONG -> uint64_t *)
(* EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> (ptr void) *)
(* UserContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymEnumTypes" sym-enum-types :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base-of-dll :uint64)   ; ULONGLONG
  (enum-symbols-callback :pointer)   ; PSYM_ENUMERATESYMBOLS_CALLBACK
  (user-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymEnumTypes = Win32::API::More->new('dbghelp',
    'BOOL SymEnumTypes(HANDLE hProcess, UINT64 BaseOfDll, LPVOID EnumSymbolsCallback, LPVOID UserContext)');
# my $ret = $SymEnumTypes->Call($hProcess, $BaseOfDll, $EnumSymbolsCallback, $UserContext);
# hProcess : HANDLE -> HANDLE
# BaseOfDll : ULONGLONG -> UINT64
# EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACK -> LPVOID
# UserContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
使用する型