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

SymEnumSourceFileTokens

関数
モジュール内のソースファイルトークンを列挙する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymEnumSourceFileTokens(
    HANDLE hProcess,
    ULONGLONG Base,
    PENUMSOURCEFILETOKENSCALLBACK Callback
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseULONGLONGinモジュールのベースアドレス。
CallbackPENUMSOURCEFILETOKENSCALLBACKinシンボル情報を受け取る SymEnumSourceFileTokensProc コールバック関数。

戻り値の型: BOOL

公式ドキュメント

モジュールのソースサーバーデータ内のすべての個別エントリを列挙します(利用可能な場合)。

戻り値

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

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

解説(Remarks)

一部のモジュールには、ソースサーバー情報を含む PDB ファイルがあり、各モジュールの作成に使用された各ソースファイルのバージョン管理情報が記載されています。アプリケーションはこの関数を使用して、「ソースインデックス化」されたすべてのソースファイルのデータを列挙できます。

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

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

各言語での呼び出し定義

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

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

SymEnumSourceFileTokens = ctypes.windll.dbghelp.SymEnumSourceFileTokens
SymEnumSourceFileTokens.restype = wintypes.BOOL
SymEnumSourceFileTokens.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    ctypes.c_void_p,  # Callback : PENUMSOURCEFILETOKENSCALLBACK
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumSourceFileTokens = dbghelp.NewProc("SymEnumSourceFileTokens")
)

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

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

typedef SymEnumSourceFileTokensNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Void>);
typedef SymEnumSourceFileTokensDart = int Function(Pointer<Void>, int, Pointer<Void>);
final SymEnumSourceFileTokens = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumSourceFileTokensNative, SymEnumSourceFileTokensDart>('SymEnumSourceFileTokens');
// hProcess : HANDLE -> Pointer<Void>
// Base : ULONGLONG -> Uint64
// Callback : PENUMSOURCEFILETOKENSCALLBACK -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumSourceFileTokens(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  Callback: Pointer   // PENUMSOURCEFILETOKENSCALLBACK
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumSourceFileTokens';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymEnumSourceFileTokens"
  c_SymEnumSourceFileTokens :: Ptr () -> Word64 -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Base : ULONGLONG -> Word64
-- Callback : PENUMSOURCEFILETOKENSCALLBACK -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

使用する型