ホーム › System.Diagnostics.Debug › FindDebugInfoFileExW

FindDebugInfoFileExW

関数

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

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

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

HANDLE FindDebugInfoFileExW(
    LPCWSTR FileName,
    LPCWSTR SymbolPath,
    LPWSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACKW Callback,   // optional
    void* CallerData   // optional
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

メモ

dbghelp.h ヘッダーは、FindDebugInfoFileEx を、UNICODE プリプロセッサ定数の定義に基づいて ANSI または Unicode バージョンの関数を自動的に選択するエイリアスとして定義します。エンコードニュートラルなエイリアスの使用と、エンコードニュートラルでないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

HANDLE FindDebugInfoFileExW(
    LPCWSTR FileName,
    LPCWSTR SymbolPath,
    LPWSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACKW Callback,   // optional
    void* CallerData   // optional
);

[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindDebugInfoFileExW(
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string SymbolPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DebugFilePath,   // LPWSTR out
    IntPtr Callback,   // PFIND_DEBUG_FILE_CALLBACKW optional
    IntPtr CallerData   // void* optional
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindDebugInfoFileExW(
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> SymbolPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> DebugFilePath As System.Text.StringBuilder,   ' LPWSTR out
    Callback As IntPtr,   ' PFIND_DEBUG_FILE_CALLBACKW optional
    CallerData As IntPtr   ' void* optional
) As IntPtr
End Function

' FileName : LPCWSTR
' SymbolPath : LPCWSTR
' DebugFilePath : LPWSTR out
' Callback : PFIND_DEBUG_FILE_CALLBACKW optional
' CallerData : void* optional
Declare PtrSafe Function FindDebugInfoFileExW Lib "dbghelp" ( _
    ByVal FileName As LongPtr, _
    ByVal SymbolPath As LongPtr, _
    ByVal DebugFilePath As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal CallerData As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindDebugInfoFileExW = ctypes.windll.dbghelp.FindDebugInfoFileExW
FindDebugInfoFileExW.restype = ctypes.c_void_p
FindDebugInfoFileExW.argtypes = [
    wintypes.LPCWSTR,  # FileName : LPCWSTR
    wintypes.LPCWSTR,  # SymbolPath : LPCWSTR
    wintypes.LPWSTR,  # DebugFilePath : LPWSTR out
    ctypes.c_void_p,  # Callback : PFIND_DEBUG_FILE_CALLBACKW 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')
FindDebugInfoFileExW = Fiddle::Function.new(
  lib['FindDebugInfoFileExW'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # DebugFilePath : LPWSTR out
    Fiddle::TYPE_VOIDP,  # Callback : PFIND_DEBUG_FILE_CALLBACKW optional
    Fiddle::TYPE_VOIDP,  # CallerData : void* optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn FindDebugInfoFileExW(
        FileName: *const u16,  // LPCWSTR
        SymbolPath: *const u16,  // LPCWSTR
        DebugFilePath: *mut u16,  // LPWSTR out
        Callback: *const core::ffi::c_void,  // PFIND_DEBUG_FILE_CALLBACKW 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.Unicode, SetLastError = true)]
public static extern IntPtr FindDebugInfoFileExW([MarshalAs(UnmanagedType.LPWStr)] string FileName, [MarshalAs(UnmanagedType.LPWStr)] string SymbolPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DebugFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_FindDebugInfoFileExW' -Namespace Win32 -PassThru
# $api::FindDebugInfoFileExW(FileName, SymbolPath, DebugFilePath, Callback, CallerData)

#uselib "dbghelp.dll"
#func global FindDebugInfoFileExW "FindDebugInfoFileExW" wptr, wptr, wptr, wptr, wptr
; FindDebugInfoFileExW FileName, SymbolPath, varptr(DebugFilePath), Callback, CallerData   ; 戻り値は stat
; FileName : LPCWSTR -> "wptr"
; SymbolPath : LPCWSTR -> "wptr"
; DebugFilePath : LPWSTR out -> "wptr"
; Callback : PFIND_DEBUG_FILE_CALLBACKW optional -> "wptr"
; CallerData : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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