ホーム › System.Diagnostics.Debug › FindDebugInfoFileEx

FindDebugInfoFileEx

関数

コールバック付きでデバッグ情報ファイルを検索する拡張版である。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	検索する .dbg ファイルの名前。部分的なパスを使用できます。
SymbolPath	LPCSTR	in	シンボルファイルが存在するパス。セミコロンで区切って複数のパスを指定できます。シンボルパスを取得するには、 SymGetSearchPath 関数を使用します。
DebugFilePath	LPSTR	out	.dbg ファイルのフルパスを受け取るバッファーへのポインター。このバッファーは少なくとも MAX_PATH+1 文字以上である必要があります。
Callback	PFIND_DEBUG_FILE_CALLBACK	inoptional	正しいファイルが見つかったか、または関数が検索を続行すべきかを検証する、アプリケーション定義のコールバック関数。詳細については、 FindDebugInfoFileProc を参照してください。このパラメーターは NULL にできます。
CallerData	void*	inoptional	コールバック関数に渡す、省略可能なユーザー定義データ。

戻り値の型: HANDLE

公式ドキュメント

FindDebugInfoFileEx 関数 (dbghelp.h) は、指定されたデバッグ (.dbg) ファイルを検索します。

戻り値

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

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

解説(Remarks)

FindDebugInfoFileEx 関数は、.dbg ファイルを検索するために使用されます。この関数は、1 回の関数呼び出しで複数の異なるディレクトリにわたって検索を実行できるように提供されています。SymbolPath パラメーターには、セミコロン (;) で区切って複数のパスを含めることができます。複数のパスが指定された場合、関数は指定された各ディレクトリでファイルを検索します。ファイルが見つかると検索は停止します。したがって、SymbolPath にはパスを正しい順序で指定してください。

指定されたファイル名に .dbg 拡張子が含まれていない場合、 FindDebugInfoFileEx は次の順序でファイルを検索します。

SymbolPath\Symbols\ext\filename.dbg
SymbolPath\ext\filename.dbg
SymbolPath\filename.dbg
FileNamePath\filename.dbg

この関数を含むすべての 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 FindDebugInfoFileEx(
    LPCSTR FileName,
    LPCSTR SymbolPath,
    LPSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACK Callback,   // optional
    void* CallerData   // optional
);

[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindDebugInfoFileEx(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // 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 FindDebugInfoFileEx(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath 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

' FileName : LPCSTR
' SymbolPath : LPCSTR
' DebugFilePath : LPSTR out
' Callback : PFIND_DEBUG_FILE_CALLBACK optional
' CallerData : void* optional
Declare PtrSafe Function FindDebugInfoFileEx Lib "dbghelp" ( _
    ByVal FileName As String, _
    ByVal SymbolPath 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

FindDebugInfoFileEx = ctypes.windll.dbghelp.FindDebugInfoFileEx
FindDebugInfoFileEx.restype = ctypes.c_void_p
FindDebugInfoFileEx.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : 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')
FindDebugInfoFileEx = Fiddle::Function.new(
  lib['FindDebugInfoFileEx'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : 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 FindDebugInfoFileEx(
        FileName: *const u8,  // LPCSTR
        SymbolPath: *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 FindDebugInfoFileEx([MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] string SymbolPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder DebugFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_FindDebugInfoFileEx' -Namespace Win32 -PassThru
# $api::FindDebugInfoFileEx(FileName, SymbolPath, DebugFilePath, Callback, CallerData)

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