ホーム › System.Diagnostics.Debug › SymFindDebugInfoFileW

SymFindDebugInfoFileW

関数

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

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

シグネチャ

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

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

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

SymFindDebugInfoFileW (Unicode) 関数は、プロセスの検索パス内から .dbg ファイルを検索します。

戻り値

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

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

解説(Remarks)

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

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

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

メモ

dbghelp.h ヘッダーは SymFindDebugInfoFile をエイリアスとして定義しており、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 SymFindDebugInfoFileW(
    HANDLE hProcess,
    LPCWSTR FileName,
    LPWSTR DebugFilePath,
    PFIND_DEBUG_FILE_CALLBACKW Callback,   // optional
    void* CallerData   // optional
);

[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymFindDebugInfoFileW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // 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 SymFindDebugInfoFileW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> FileName 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

' hProcess : HANDLE
' FileName : LPCWSTR
' DebugFilePath : LPWSTR out
' Callback : PFIND_DEBUG_FILE_CALLBACKW optional
' CallerData : void* optional
Declare PtrSafe Function SymFindDebugInfoFileW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal FileName 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

SymFindDebugInfoFileW = ctypes.windll.dbghelp.SymFindDebugInfoFileW
SymFindDebugInfoFileW.restype = ctypes.c_void_p
SymFindDebugInfoFileW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCWSTR,  # FileName : 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')
SymFindDebugInfoFileW = Fiddle::Function.new(
  lib['SymFindDebugInfoFileW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : 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 SymFindDebugInfoFileW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        FileName: *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 SymFindDebugInfoFileW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string FileName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder DebugFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFindDebugInfoFileW' -Namespace Win32 -PassThru
# $api::SymFindDebugInfoFileW(hProcess, FileName, DebugFilePath, Callback, CallerData)

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