ホーム › System.Diagnostics.Debug › SymFindExecutableImage

SymFindExecutableImage

関数

コールバックを用いて実行イメージファイルを検索する。

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

シグネチャ

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

HANDLE SymFindExecutableImage(
    HANDLE hProcess,
    LPCSTR FileName,
    LPSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACK Callback,
    void* CallerData
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

SymFindExecutableImage 関数 (dbghelp.h) は、プロセスの検索パス内で実行可能ファイルを検索します。

戻り値

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

関数が失敗した場合、戻り値は 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 SymFindExecutableImage(
    HANDLE hProcess,
    LPCSTR FileName,
    LPSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACK Callback,
    void* CallerData
);

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

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

' hProcess : HANDLE
' FileName : LPCSTR
' ImageFilePath : LPSTR out
' Callback : PFIND_EXE_FILE_CALLBACK
' CallerData : void*
Declare PtrSafe Function SymFindExecutableImage Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal FileName As String, _
    ByVal ImageFilePath 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "dbghelp")]
extern "system" {
    fn SymFindExecutableImage(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u8,  // LPCSTR
        ImageFilePath: *mut u8,  // LPSTR out
        Callback: *const core::ffi::c_void,  // PFIND_EXE_FILE_CALLBACK
        CallerData: *mut ()  // void*
    ) -> *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 SymFindExecutableImage(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ImageFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFindExecutableImage' -Namespace Win32 -PassThru
# $api::SymFindExecutableImage(hProcess, FileName, ImageFilePath, Callback, CallerData)

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

出力引数:

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