ホーム › System.Diagnostics.Debug › SymFindDebugInfoFile

SymFindDebugInfoFile

関数

コールバックを用いてデバッグ情報ファイルを検索する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

HANDLE SymFindDebugInfoFile(
    HANDLE hProcess,
    LPCSTR FileName,
    LPSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACK Callback,   // optional
    void* CallerData   // optional
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	元々 SymInitialize 関数に渡されたプロセスへのハンドル。
FileName	LPCSTR	in	.dbg ファイルの名前。部分的なパスを使用できます。
DebugFilePath	LPSTR	out	.dbg ファイルの完全修飾パス。このバッファーは少なくとも MAX_PATH+1 文字必要です。
Callback	PFIND_DEBUG_FILE_CALLBACK	inoptional	正しいファイルが見つかったかどうか、または関数が検索を継続すべきかを検証する、アプリケーション定義のコールバック関数。詳細については、 FindDebugInfoFileProc を参照してください。このパラメーターは NULL にできます。
CallerData	void*	inoptional	ユーザー定義の値、または NULL。この値はそのままコールバック関数に渡されます。このパラメーターは通常、コールバック関数に何らかのコンテキストを提供するデータ構造体へのポインターを渡すために、アプリケーションによって使用されます。

戻り値の型: HANDLE

公式ドキュメント

SymFindDebugInfoFile 関数 (dbghelp.h) は、プロセスの検索パス内で .dbg ファイルを探します。

戻り値

関数が成功した場合、戻り値は .dbg ファイルへのオープンされたハンドルです。

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

解説(Remarks)

この関数は、 SymInitialize または SymSetSearchPath 関数で設定された検索パスを使用します。

この関数を含むすべての 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>

HANDLE SymFindDebugInfoFile(
    HANDLE hProcess,
    LPCSTR FileName,
    LPSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACK Callback,   // optional
    void* CallerData   // optional
);

[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymFindDebugInfoFile(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder DebugFilePath,   // LPSTR out
    IntPtr Callback,   // PFIND_DEBUG_FILE_CALLBACK optional
    IntPtr CallerData   // void* optional
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymFindDebugInfoFile(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> DebugFilePath As System.Text.StringBuilder,   ' LPSTR out
    Callback As IntPtr,   ' PFIND_DEBUG_FILE_CALLBACK optional
    CallerData As IntPtr   ' void* optional
) As IntPtr
End Function

' hProcess : HANDLE
' FileName : LPCSTR
' DebugFilePath : LPSTR out
' Callback : PFIND_DEBUG_FILE_CALLBACK optional
' CallerData : void* optional
Declare PtrSafe Function SymFindDebugInfoFile Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal FileName As String, _
    ByVal DebugFilePath As String, _
    ByVal Callback As LongPtr, _
    ByVal CallerData As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymFindDebugInfoFile = ctypes.windll.dbghelp.SymFindDebugInfoFile
SymFindDebugInfoFile.restype = ctypes.c_void_p
SymFindDebugInfoFile.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPSTR,  # DebugFilePath : LPSTR out
    ctypes.c_void_p,  # Callback : PFIND_DEBUG_FILE_CALLBACK optional
    ctypes.POINTER(None),  # CallerData : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymFindDebugInfoFile = Fiddle::Function.new(
  lib['SymFindDebugInfoFile'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # DebugFilePath : LPSTR out
    Fiddle::TYPE_VOIDP,  # Callback : PFIND_DEBUG_FILE_CALLBACK optional
    Fiddle::TYPE_VOIDP,  # CallerData : void* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "dbghelp")]
extern "system" {
    fn SymFindDebugInfoFile(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u8,  // LPCSTR
        DebugFilePath: *mut u8,  // LPSTR out
        Callback: *const core::ffi::c_void,  // PFIND_DEBUG_FILE_CALLBACK optional
        CallerData: *mut ()  // void* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SymFindDebugInfoFile(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder DebugFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFindDebugInfoFile' -Namespace Win32 -PassThru
# $api::SymFindDebugInfoFile(hProcess, FileName, DebugFilePath, Callback, CallerData)

#uselib "dbghelp.dll"
#func global SymFindDebugInfoFile "SymFindDebugInfoFile" sptr, sptr, sptr, sptr, sptr
; SymFindDebugInfoFile hProcess, FileName, varptr(DebugFilePath), Callback, CallerData   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; FileName : LPCSTR -> "sptr"
; DebugFilePath : LPSTR out -> "sptr"
; Callback : PFIND_DEBUG_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymFindDebugInfoFile "SymFindDebugInfoFile" sptr, str, var, sptr, sptr
; res = SymFindDebugInfoFile(hProcess, FileName, DebugFilePath, Callback, CallerData)
; hProcess : HANDLE -> "sptr"
; FileName : LPCSTR -> "str"
; DebugFilePath : LPSTR out -> "var"
; Callback : PFIND_DEBUG_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymFindDebugInfoFile "SymFindDebugInfoFile" sptr, str, sptr, sptr, sptr
; res = SymFindDebugInfoFile(hProcess, FileName, varptr(DebugFilePath), Callback, CallerData)
; hProcess : HANDLE -> "sptr"
; FileName : LPCSTR -> "str"
; DebugFilePath : LPSTR out -> "sptr"
; Callback : PFIND_DEBUG_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。